C++编程规范31.ppt

杨帆 2012.10 一、概述 对于任何工程项目来说，统一的施工标准都是保证工程质量的重要因素。堪称当今人类最抽象、最复杂的工程——软件工程，自然更加不能例外。高品质、易维护的软件开发离不开清晰严格的编码规范。 本文档中的编码规范都以如下表格格式给出，其中强制性规则使用黑色，建议性规则使用紫色： 二、字体与语法高亮 字体规范 语法高亮 二、文件结构 文件头注释 所有C++的源文件均必须包含一个规范的文件头，文件头包含了该文件的名称、功能概述、作者、版权和版本历史信息等内容。 格式参见： comment-head.cpp 头文件 实现文件 应用程序的文件组织形式 三、命名规则 命名规范的整体原则 类/结构 函数 变量 作用域前缀 类型前缀 四、代码风格与版式 整体原则 空行的使用 空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。 在每个类声明之后、每个函数定义结束之后都要加一行空行。 在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。 语句与代码行 一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 if、for、while、do、try、catch 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加 { } 。这样可以防止书写失误。 缩进和对齐 程序的分界符 { 和 } 应独占一行并且位于同一列，同时与引用它们的语句左对齐。 “{ }” 之内的代码块在 “{” 右边一个制表符（4个半空格符）处左对齐。如果出现嵌套的 “{ }”，则使用缩进对齐。 最大长度 代码行最大长度宜控制在70至80个字符以内。 长行拆分 长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。 空格的使用 关键字之后要留空格。象 “const”、“virtual”、“inline”、“case” 等关键字之后至少要留一个空格，否则无法辨析关键字。象 “if”、“for”、“while”、“catch” 等关键字之后应留一个空格再跟左括号 “(”，以突出关键字。 函数名之后不要留空格，紧跟左括号 “(” ，以与关键字区别。 “(” 向后紧跟，而 “)”、“,”、“;” 向前紧跟，紧跟处不留空格。 , 之后要留空格，如 Function(x, y, z)。如果 ; 不是一行的结束符号，其后要留空格，如 for (initialization; condition; update)。 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=” “=”、“=”、“+”、“*”、“%”、“”、“||”、“”, “^” 等二元操作符的前后应当加空格。 一元操作符如 “!”、“~”、“++”、“--”、“”（地址运算符）等前后不加空格。 象“[]”、“.”、“-”这类操作符前后不加空格。 对于表达式比较长的for、do、while、switch语句和if语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i10; i++)和if ((a=b) (c=d)) 修饰符的位置 为便于理解，应当将修饰符 * 和 紧靠数据类型。 注释 注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。 注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。 类的版式 注释头与类声明 与文件一样，每个类应当有一个注释头用来说明该类的各个方面。 类声明换行紧跟在注释头后面，class 关键字由行首开始书写，后跟类名称。 界定符 “{” 和 “};” 应独占一行，并与 “class” 关键字左对齐。 对于功能明显的简单类（接口小于10个），也可以使用简单的单行注释头 格式参见：comment-class.cpp 继承 基类直接跟在类名称之后，不换行，访问说明符（public, private, 或protected）不可省略。 class CXXX : public CAAA, private CBBB{??? // ...}; 以行为为中心 将公有的定义和成员放在类声明的最前面，保护的放在中间，而私有的摆在最后。 访问说明符 访问说明符（public, private, 或protected）应该独占一行，并与类声明中的‘class’关键字左对齐。 类成员的声明版式 每