1、C#开发规范 易泓管理咨询开发参考文档文档准备人： 张炜制作日期： 2010年 01月 08日提交日期： 2010年 01月 08日版本号： V1.0状态：易泓管理咨询浙江省杭州市滨江区江陵路 1760号邮编：310051易泓公司 但是方法名和左括号之间不应该有空格。参数之间的逗号后应该加一空格。如：method1(int i1, int i2)for 语句里的表达式之间加一空格。如：for(expr1; expr2; expr3)二元操作符和操作数之间应该用空格隔开。如：i + c ;强制类型转换时，在类型和变量之间加一空格。如：(int) i ;内部参考文件C#开发规范 Last prin
2、ted 5 月/08/2008 | Page 7 of 133. 注释3.1. 注释的基本约定3.1.1 注释的基本约定3.1.2 注释应该增加代码的清晰度3.1.3 保持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性3.1.4 注释不应该包括其他的特殊字符3.1.5 先写注释，后写代码3.2. 注释类型3.2.1 块注释块注释：主要用来描述文件，类，方法，算法等。一般用在文档和方法的前面，也可以放在文档的任何地方。以/*开头，*/结尾。例：/* 注释*/3.2.2 行注释行注释：主要用在方法内部，对代码，变量，流程等进行说明。与块注释格式相似，但是整个注释占据一行。例
3、：/* 注释 */3.2.3 尾随注释尾随注释：与行注释功能相似，放在代码的同行，但是要与代码之间有足够的空间，便于分清。例：int m=4 ; /* 注释 */内部参考文件C#开发规范 Last printed 5 月/08/2008 | Page 8 of 13如果一个程序块内有多个尾随注释，每个注释的缩进应该保持一致。3.2.4 行尾注释行尾注释：与行注释功能相似，放在每行的最后，或者占据一行。以/开头或以/开头。3.2.5 文档注释文档注释：与块注释相似，但是可以被 javadoc 处理，生成 HTML 文件。以/*开头，*/结尾。问挡住是不能放在方法或程序块内。例：/*注释*/3.3
4、. 注释那些部分项目 注释哪些部分实参/ 参数参数类型 参数用来做什么任何约束或前提条件示例字段/ 字段/属性字段描述 注释所有使用的不变量示例并行事件可见性决策类 类的目的 已知的问题类的开发/维护历史注释出采用的不变量并行策略编译单元 每一个类/类内定义的接口，含简单的说明 文件名和/或标识信息版权信息接口 目的 它应如何被使用以及如何不被使用局部变量 用处/目的成员函数注释 成员函数做什么以及它为什么做这个 内部参考文件C#开发规范 Last printed 5 月/08/2008 | Page 9 of 13哪些参数必须传递给一个成员函数成员函数返回什么已知的问题任何由某个成员函数抛出
5、的异常可见性决策成员函数是如何改变对象的包含任何修改代码的历史如何在适当情况下调用成员函数的例子适用的前提条件和 后置条件成员函数内部注释控制结构 代码做了些什么以及为什么这样做局部变量难或复杂的代码处理顺序4. 命名4.1. 命名的基本约定4.1.1 一般应该使用可以准确说明变量/字段/类/命令空间的完整的英文描述符，如 firstName。对一些作用显而易见的变量可以采用简单的命名，如在循环里的递增（减）变量就可以被命名为 ” i ”。4.1.2 尽量采用项目所涉及领域的术语。4.1.3 可以采用大小写混合，提高名字的可读性。4.1.4 尽量少用缩写，但如果一定要使用，就要谨慎地使用。同时
6、，应该保留一个标准缩写的列表，并且在使用时保持一致。4.1.5 避免使用长名字（最好不超过 15 个字母）。4.1.6 避免使用相似或者仅在大小写上有区别的名字。4.1.7 避免使用下划线作为名字的首末字母。4.2. 标示符的命名约定标示符类型 命名约定 例子内部参考文件C#开发规范 Last printed 5 月/08/2008 | Page 10 of 13命令空间（文件名）namespace 全部小写。 标识符用点号分隔开来。为了使包的名字更易读，建议命令空间中的标识符用点号来分隔。局部包：interface.screens类，接口 类的名字应该使用名词。 每个单词第一个字母应该大写。 避免使用单词的错写，除非它的缩写已经广为人知，如 HTTP。Class Hello ;Class HelloWorld ;Interface Apple ;方法 第一个单词一般是动词。 第一个字母是小些，但是中间单词的第一个字母是大写。 如果方法返回一个成员变量的值，方法名一般为get+成员变量名，如若返回的值是 bool 变量，一般以 is 作为前缀。 如果方法修改一个成员变量的值，方法名一般为：set + 成员变量名。 如果方法返回一个结束结束集或字符串,方法名一般为:do+成员变量名.getName();setName();isFirst();doAddressSearch();
