c项目撰写规范.docVIP

第一章 概述 规范制定原则 1 方便代码的交流和维护。 2 不影响编码的效率，不与大众习惯冲突。 3 使代码更美观、阅读更方便。 4 使代码的逻辑更清晰、更易于理解。 术语定义 Pascal 大小写 将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： BackColor Camel 大小写 标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如： backColor 第二章 代码外观 2.1 列宽 代码列宽控制在110字符左右。 2.2 换行 当表达式超出或即将超出规定的列宽，遵循以下规则进行换行 1、在逗号后换行。 2、在操作符前换行。 2.3 缩进 缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。 2.4 空行 空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。 在以下情况下使用两个空行 1、接口和类的定义之间。 2、枚举和类的定义之间。 3、类与类的定义之间。 在以下情况下使用一个空行 1、方法与方法、属性与属性之间。 2、方法中变量声明与语句之间。 3、方法与方法之间。 4、方法中不同的逻辑块之间。 　 5、方法中的返回语句与其他的语句之间。 6、属性与方法、属性与字段、方法与字段之间。 2.5 花括号 - {} 1、 左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如 if (condition) { } public int Add(int x, int y) { } 2、 左花括号 “{” 要与相应的右花括号 “}”对齐。 3、 通常情况下左花括号 “{”单独成行，不与任何语句并列一行。 4、 if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。如 if (somevalue == 1) { somevalue = 2; } 5、 右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如 while (1) { if (valid) { } // if valid else { } // not valid } // end forever 第三章 程序注释 3.1 注释概述 1、修改代码时，总是使代码周围的注释保持最新在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的。 避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。 避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。在部署之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。 在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。使用注释来解释代码的意图。它们不应作为代码的联机翻译。 注释代码中不十分明显的任何内容。 int level; //推荐 int size; //推荐 int x, y; //不推荐 4.2 初始化 建议在变