编码规范.doc

C#编码规范 Version 1.0 河北工程大学 软件开发团队 2011年8月 1 概述 1 1.1 规范制定原则 1 1.2 命名法则分类 1 1.3 标识符命名约定 1 2 代码外观 2 2.1 列宽 2 2.2 换行 2 2.3 缩进 2 2.4 空行 2 2.5 空格 2 2.6 括号 - () 3 2.7 花括号 - {} 3 3 程序注释 5 3.1 注释概述 5 3.2 文档型注释 5 3.3 多行注释 6 3.4 单行注释 6 4 申明 7 4.1 每行声明变量数 7 4.2 变量初始化 7 4.3 变量声明的位置 7 4.4 方法的声明 8 4.5 字段的声明 8 5 命名规范 9 5.1 命名概述 9 5.2 缩写 9 5.3 命名空间 10 5.4 类 10 5.5 接口 10 5.6 属性 (Attribute) 11 5.7 枚举 (Enum) 11 5.8 参数 11 5.9 方法 12 5.10 属性(property) 12 5.11 事件 13 5.12 常量 (const) 14 5.13 字段 14 5.14 静态字段 15 5.15 集合 15 6 语句 16 6.1 每行一个语句 16 6.2 复合语句 16 6.3 return 语句 16 附录A 匈牙利命名法下的控件缩写 17 1 概述 1.1 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。 1.2 命名法则分类 1 Pascal 命名法 将标识符的首字母和后面连接的每个单词的首字母都大写。例如：BackColor 2 Camel 命名法 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor 3 Hungarian命名法 标识符带有表达某种含义的前缀，前缀字符串一般小写，后面每个单词首字母大写，如intBookNum。也有特殊情况，如ICompany，I表示接口。 1.3 标识符命名约定 1 控件（包含Web窗体控件、Windows窗体控件） 使用Hungarian命名法。 2 命名空间（namespace） 使用Pascal命名法。 3 类（class）、委托（delegate） 使用Pascal命名法。 4 接口（interface） 使用Hungarian命名法 5 函数、属性 使用Pascal命名法。 6 字段、变量、形参 使用Camel 命名法。 7 文件 使用Pascal命名法。 2 代码外观 2.1 列宽 代码列宽控制在110字符左右。 2.2 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行。 1、在逗号后换行。 2、在操作符前换行。 3、规则1优先于规则2。 当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。 2.3 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。Visual Studio.Net设置：工具-选项-文本编辑器-C#-制表符-插入空格 2.4 空行 空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。 在以下情况下使用两个空行 1、接口和类的定义之间。 2、枚举和类的定义之间。 3、类与类的定义之间。 在以下情况下使用一个空行 1、方法与方法、属性与属性之间。 2、方法中变量声明与语句之间。 3、方法与方法之间。 4、方法中不同的逻辑块之间。 5、方法中的返回语句与其他的语句之间。 6、属性与方法、属性与字段、方法与字段之间。 7、注释与它注释的语句间不空行，但与其他的语句间空一行。 2.5 空格 在以下情况中要使用到空格 1、关键字和左括符 “(” 应该用空格隔开。如 while (true) 注意在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。 2、多个参数用逗号隔开，每个逗号后都应加一个空格。 3、除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作。数间不需要空格。如 a += c + d; a = (a + b) / (c * d); while (d++ = s++) { n++; } PrintSize(“size is “ + size + “\n”); 4、语句中的表达式之间用空格隔开。如 for (expr1; expr2; expr3