团队C#代码规范.docVIP

第一章　概述 1.1 规范的重要性 增加开发过程中代码的强壮性、可读性、易维护性 减少有经验和无经验开发人员编码所需的脑力工作 为软件的良好维护性打下好的基础 在项目组内部易于代码层面的沟通 使新的开发人员快速的适应项目氛围 一个优秀而且职业化的开发团队所必须的素质 1.2 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。 1.3 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 第二章 代码外观 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) 注意：在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。多个参数用逗号隔开，每个逗号后都应加一个空格。 除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作数间不需要空格。如 a += c + d; a = (a + b) / (c * d); while (d++ = s++) { n++; } PrintSize(“size is “ + size + “\n”); 3、 语句中的表达式之间用空格隔开。如 for (expr1; expr2; expr3) 2.6 花括号 - {} 1、 左花括号 “{” 放于关键字或方法名的下一行并与之对齐。 2、 左花括号 “{” 要与相应的右花括号 “}”对齐。 3、 通常情况下左花括号 “{”单独成行，不与任何语句并列一行。如 if (condition) { } public int Add(int x, int y) { } 第三章 程序注释 3.1原则 代码未写，注释先行 重中之重，利人利己，对每个方法、关键步骤、重要变量需要良好的代码注释，并养成好习惯。 确保注释的维护与更新与源代码同时进行。 尽管正确注释源代码在运行时没有任何用途，但这对于必须维护特别复杂或麻烦的软件片段的开发人员来说却是无价的。 3.2 注释概述 1、修改代码时，总是使代码周围的注释保持最新在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共