软件编程规范.doc

代码编程规范

每次签入时，
写出单元测试，测试驱动开发
编码
3、能通过所有测试
4、通过重命名、消除重复代码、拆分过长的函数、切分对象、清理嵌套、抽取方法、更新或清除注释等方法，使代码比签出时更加干净、整洁、具有可读性。

VS自带的单元测试的步骤：

1、命名
1.2文件命名组织
文件名遵从Pascal命名法，扩展名小写。例如，BackColor.cs。
5.1概述
Bool变量名包含Is，如fileIsFound。
任何时候一旦想到更好的名字，毫不犹豫的重命名。VisualStudio中右键-“重构”-“重命名”。
5.2大写规则
只有非公有的字段、参数、方法内的变量使用Camel大小写，如backColor。其它情况使用Pascal大小写。
5.3类、对象、接口、属性和方法
用名词或名词短语命名类、对象和属性，用名词、名词短语或者描述行为的形容词命名接口，用动词或动词短语命名方法。
给接口名称加上大写字母I作为前缀。
5.4常量
所有单词大写，多个单词之间用“_”隔开，如PAGE_TITLE。
5.5集合
集合的命名用复数。

只写与代码的表达无关的注释。包括：
在代码修改、错误修复后，添加额外的注释。
2、文件注释，包括版权和创建和更新日志，源代码管理工具可以让更新日志去掉！！！！！！！！！！！！。
文件注释可以使用附带的head.snippet和source.snippet文件，分别用于头文件和源文件的头注释，具体操作如下：
a、放到“文档”中\VisualStudio2010\CodeSnippets\VisualC#\MyCodeSnippets中；
b、VS中的“代码段管理器”中导入；
c、VS文本编辑器中输入head或source，按两次TAB。
3、对每个空循环添加确认性注释。
4、字符串拼接添加实例性注释。
5、编码之外的活动。例如作者做出的权衡和考虑、问题的解决方案、警示陷阱、解释原因等作者想的东西。
6、todo注释
7、用函数名称、变量名称表达名字太长。
8、在多层嵌套中，建议在右花括号后加一个注释，标记对应的左花括号。
9、复杂算法

三、程序注释
3.2XML标签注释
在已经申明好的接口、类、方法、属性的前一行输入“///”来产生。
3.3单行注释
当申明变量时，使用对齐了的行尾注释。
3.4其它
当一段代码的含义不是十分明显时，先考虑重写，再考虑添加注释。
注释同步更新
“//”的后面插入一个空格。

一、概述
1.1规范基本原则
方便代码的交流和维护。
不影响编码的效率，不与大众习惯冲突。
使代码更美观、阅读更方便。
使代码的逻辑更清晰、更易于理解。

二、代码外观
2.1列宽和换行
列宽控制在110个字符左右。
如果超过：
在逗号后换行。
在操作符前换行。
规则1优先于规则2。

2.2缩进、空格、括号、花括号
编码时用TAB来缩进。在VisualStudio的“工具”-“选项”-“文本编辑器”-“C#”-“制表符”中选择“插入空格”。
可以用VisualStudio自带的Ctrl+K+C快捷键来处理这些问题。

2.3空行
类、接口和枚举相互之间空两行。
字段、方法和属性相互之间：字段之间不空行，其它情况都空一行。
方法中不同逻辑块之间空一行。
方法中变量申明、返回语句和注释语句与其它部分的语句之间空一行。

四、声明
4.1位置
C++中放在底部，C#和JAVA的变量的声明置于块的开始。原则上放在大家都会知道应该在的地方。
调用者放在被调用者的前方。

七、控件命名
TypePrefixExampleButtonbtnbtnSubmitCheckBoxchkchkBlueDataGriddgrddgrdTitlesDataListdlstdlstTitlesDropDownListdropdropCountriesImageimgimgAuntBettyLabellbllblResultsListBoxlstlstCountriesPanelpnlpnlForm2RadioButtonradradFemaleRepeaterrptrptQueryResultsTabletbltblCountryCodesTextBoxtxttxtFirstNameFormfrmfrmLogin