C#代码编写规范.pdf

1. 简介 本规范为一套编写高效可靠的 C# 代码的标准、约定和指南。它以安全可靠的软件工程原则为基础， 使代码易于理解、维护和增强，提高生产效率。同时，将带来更大的一致性，使软件开发团队的效率明显 提高。 2. 适用范围 本规范适用于公司所有的C#源代码，为详细设计，代码编写和代码审核提供参考和依据。 3. 文体 本规范中的建议分为四种：要，建议，避免，不要，表示需要遵循的级别。文档中会以粗体表示。 对于应遵循的规范，前面会以“”来表示，对不好的做法前面会以“”来表示： 要：描述必须遵循的规范。例如： 异常类要以“Exception”做为后缀； 建议：描述在一般情况下应该遵循的规范，但如果完全理解规范背后的道理，并有很好的理由不遵 循它时，也不畏惧打破常规。例如： 强制类型转换时，在类型和变量之间建议加一空格。 不要：描述一些几乎绝对绝不应该违反的规范。例如： 每个函数有效代码（不包括注释和空行）长度不要超过50 行。 避免：与建议相对，一般情况下应该遵循，但有很好的理由时也可以打破。例如： 避免块内部的变量与它外部的变量名相同。 对一些规范内容一并提供了示例代码。 4. 代码组织与风格 4.1. Tab 要使一个Tab 为4 个空格长。 4.2. 缩进 要使一个代码块内的代码都统一缩进一个Tab 长度。 4.3. 空行 建议适当的增加空行，来增加代码的可读性。 在在类，接口以及彼此之间要有两行空行： 在下列情况之间要有一行空行： 方法之间； 局部变量和它后边的语句之间； 方法内的功能逻辑部分之间； 4.4. 函数长度 每个函数有效代码（不包括注释和空行）长度不要超过50 行。 4.5. {”，“}” 开括号“{”要放在块的所有者的下一行，单起一行； 闭括号“}”要单独放在代码块的最后一行，单起一行。 4.6. 行宽 每行代码和注释不要超过70 个字符或屏幕的宽度，如超过则应换行，换行后的代码应该缩进一个Tab 。 4.7. 空格 括号和它里面的字符之间不要出现空格。括号应该和它前边的关键词留有空格，如：while (true) {}; 但是方法名和左括号之间不要有空格。 参数之间的逗号后要加一空格。如：method1(int i1, int i2) for 语句里的表达式之间要加一空格。如：for (expr1; expr2; expr3) 二元操作符和操作数之间要用空格隔开。如：i + c; 强制类型转换时，在类型和变量之间要加一空格。如：(int) i ; 5. 注释 5.1. 注释的基本约定 注释应该增加代码的清晰度； 保持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性。 注释不要包括其他的特殊字符。 建议先写注释，后写代码，注释和代码一起完成 如果语句块（比如循环和条件分枝的代码块）代码太长，嵌套太多，则在其结束“ ｝”要加上注释，标 志对应的开始语句。如果分支条件逻辑比较复杂，也要加上注释。 在VS20 10 环境中通过配置工程编译时输出XML 文档文件可以检查注释的完整情况，如果注释不完 整会报告编译警告； 5.2. 注释类型 5.2.1. 文件头注释 参见截图： 5.2.2. 块注释 主要用来描述文件，类，方法，算法等，放在所描述对象的前边。具体格式以IDE 编辑器输入“///” 自动生成的格式为准。 对类和接口的注释必须加上上述标记，对方法可以视情况考虑 5.2.3. 行注释 主要用在方法内部，对代码，变量，流程等进行说明。整个注释占据一行。 5.2.3. 尾随注释 与行注释功能相似，放在代码的同行，但是要与代码之间有足够的空间，便于分清。例： int m = 4 ; / ／注释 如果一个程序块内有多个尾随注释，每个注释的缩进要保持一致。 5.3. 注释哪些部分 项目 注释哪些部分 参数 参数用来做什么 任何约束或前提条件 字段/属性 字段描述 类