程序员规范附录AC编码规范.docVIP

C#编码规范 TQC-DS项目 作者：丁旭峰 日期：2008-7-15 版本：1.0 目的 为了TQC-DS项目组编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 范围 适用于TQC-DS项目基于.NET平台的软件开发工作。 规范内容 缩进（Indenting） 所有的缩进使用1个Tab（VS.Net中等于4个空格的距离）。 大括号（Bracing） 大括号{}必须单独占用1行（在可省略的情况下也必须使用，如if后的单行语句），在{}中的内容缩进1个Tab的距离。 例如： if (someExpression) { DoSomething(); } else { DoSomethingElse(); } “case” statements should be indented from the switch statement like this: switch (someExpression) { case 0: DoSomething(); break; case 1: DoSomethingElse(); break; case 2: { int n = 1; DoAnotherThing(n); } break; } 注释（Commenting） 注释应该描述代码的目的、算法和逻辑流程。理想状况下，通过注释可以直接了解一个模块、函数或代码块的设计意图和实现手段。 模块（类）注释 模块开始必须以以下形式书写模块注释： ///summary ///模块编号：模块编号，可以引用系统设计中的模块编号 ///作用：对此类的描述，可以引用系统设计中的描述 ///作者：作者中文名 ///编写日期：模块创建日期，格式：YYYY-MM-DD ////summary 如果模块有修改，则每次修改必须添加以下注释： ///summary ///Log编号：Log编号,从1开始一次增加 ///修改描述：对此修改的描述 ///作者：修改者中文名 ///修改日期：模块修改日期，格式：YYYY-MM-DD /////summary 类属性注释规范 在类的属性必须以以下格式编写属性注释： ///summary ///属性说明 ////summary 方法注释规范 在类的方法声明前必须以以下格式编写注释 ///summary ///说明：对该方法的说明 ////summary /// param name=参数名称参数说明/param /// returns ///对方法返回值的说明，该说明必须明确说明返回的值代表什么含义 ////returns 代码间注释规范 代码间注释分为单行注释和多行注释： 单行注释： //单行注释 多行注释： /*多行注释1 多行注释2 多行注释3*/ 代码中遇到语句块时必须添加注释（if,for,foreach,……）,添加的注释必须能够说明此语句块的作用和实现手段（所用算法等等）。 空格（Spacing） 空格可以通过降低代码密度来提高代码的可读性，下面是一些空格的使用范例： 在函数调用需要多个参数时，每个参数的“,”后使用1个空格√: Console.In.Read(myChar, 0, 1);×: Console.In.Read(myChar,0,1); 在调用函数时，(与参数之间不要使用空格√:CreateFoo(myChar, 0, 1)×:CreateFoo( myChar, 0, 1 ) 函数名和(之间不要使用空格√: CreateFoo()×: CreateFoo () []内不要使用空格√: x = dataArray[index];×: x = dataArray[ index ]; 在控制字符后使用1个空格√: while (x == y)×: while(x == y) 在比较操作两边各使用1个空格√: if (x == y)×: if (x==y) 命名（Naming） 大小写约定 使用下面的三种大写标识符约定。 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用 Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首