CC++编码规范.docx

1、CC+编码规范文件编号：4-03/1.0分 册 号：1/1页 码：密 级：1.0C/C+ 编码规范xxxxx公司二二年十一月文件变更记录*A 增加 M 修改 D 删节变更版本日期图表、表格、段落号A/M/D原因与修改情况描述修订人审核人1.02002/11/15A第一版xxxxxx目 录1 文件结构 11.1版权和版本的声明 11.2 头文件的结构 21.3 定义文件的结构 31.4 头文件的作用 31.5 目录结构 32 程序的版式 42.1 版式 42.2 代码行 52.3 代码行内的空格 62.4 对齐 72.5 长行拆分 72.6 修饰符的位置 82.7 注释 82.8 类的版式 10

2、3 命名规则 103.1 共性规则 113.2 简单的Windows 应用程序命名规则 124 表达式和基本语句 134.1 运算符的优先级 134.2 复合表达式 144.3 if 语句 154.3.1 布尔变量与零值比较 154.3.2 整型变量与零值比较 154.3.3 浮点变量与零值比较 164.3.4 指针变量与零值比较 164.3.5 对if 语句的补充说明 164.4 循环语句的效率 174.5 for 语句的循环控制变量 184.6 switch 语句 184.7 goto 语句 195 常量 195.1 为什么需要常量 205.2 const 与#define 的比较 205

3、.3 常量定义规则 205.4 类中的常量 216 函数设计 226.1 参数的规则 226.2 返回值的规则 236.3 函数内部实现的规则 256.4 其它建议 276.5 使用断言 276.6 引用与指针的比较 287 C/C+代码审查程式文件 30前 言世上不存在最好的编程风格，一切因需求而定。团队开发讲究风格一致，如果制定了大家认可的编程风格，那么所有组员都要遵守。如果各位同事觉得本文的编程风格比较合你的工作，那么就采用它，不要只看不做。人在小时候说话发音不准，写字潦草，如果不改正，总有后悔的时候。编程也是同样道理。本文应金融事业部质控总监徐建一要求整理编写，作为金融事业部c/c+编

4、码的试行格式规范草稿。希望能够在实施过程中，得到各位编程高手和资深专家的指点，不断的改进，形成适合部门需要，并且能够的得到部门所有编程人员认可的编程规范。本文以上海贝尔林锐博士的高质量c+/c编程指南为底稿，参考了中间件公司牛文强的c+编程规范，brian w.kernighan的程序设计实践等书。1 文件结构每个C+/C 程序通常分为两个文件。一个文件用于保存程序的声明（declaration），称为头文件。另一个文件用于保存程序的实现（implementation），称为定义（definition）文件。C+/C 程序的头文件以“.h”为后缀，C 程序的定义文件以“.c”为后缀，C+程序的

5、定义文件通常以“.cpp”为后缀（也有一些系统以“.cc”或“.cxx”为后缀）。1.1版权和版本的声明版权和版本的声明位于头文件和定义文件的开头（参见示例1-1），主要内容有：（1）版权信息。（2）文件名称，标识符，摘要。（3）当前版本号，作者/修改者，完成日期。（4）版本历史信息。示例1-1 版权和版本的声明1.2 头文件的结构头文件由三部分内容组成：（1）头文件开头处的版权和版本声明（参见示例1-1）。（2）预处理块。（3）函数和类结构声明等。假设头文件名称为graphics.h，头文件的结构参见示例1-2。 【规则1-2-1】为了防止头文件被重复引用，应当用ifndef/define/

6、endif 结构产生预处理块。 【规则1-2-2】用#include 格式来引用标准库的头文件（编译器将从标准库目录开始搜索）。 【规则1-2-3】用#include “filename.h” 格式来引用非标准库的头文件（编译器将从用户的工作目录开始搜索）。 【建议1-2-1】头文件中只存放“声明”而不存放“定义”在C+ 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定义与声明分开，不论该函数体有多么小。 【建议1-2-2】不提倡使用全局变量，尽量不要在头文件中出现象extern int value

7、这类声明。示例1-2 C+/C 头文件的结构1.3 定义文件的结构定义文件有三部分内容：（1） 定义文件开头处的版权和版本声明（参见示例1-1）。（2） 对一些头文件的引用。（3） 程序的实现体（包括数据和代码）。假设定义文件的名称为graphics.cpp，定义文件的结构参见示例1-3。示例1-3 C+/C 定义文件的结构1.4 头文件的作用早期的编程语言如Basic、Fortran 没有头文件的概念，C+/C 语言的初学者虽然会用使用头文件，但常常不明其理。这里对头文件的作用略作解释：（1）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只要向用户提供头文件和二进制的库

8、即可。用户只需要按照头文件中的接口声明来调用库功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错的负担。1.5 目录结构如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分别保存于不同的目录，以便于维护。例如可将头文件保存于include 目录，将定义文件保存于source 目录（可以是多级目录）。如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声明”。为了加强信息隐藏，这些私有的头文件可以

9、和定义文件存放于同一个目录。2 程序的版式2.1 版式版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。【规则2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。参见示例【规则2-1-2】在一个函数体内，

10、逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b ）示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行2.2 代码行【规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。【规则2-2-2】if、for、while、do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加。这样可以防止书写失误。int width; / 宽度int height; / 高度int depth; / 深度int width, height, depth; / 宽度高度深度x = a + b;y = c +

11、 d;z = e + f;X a + b; y = c + d; z = e + f;if (width height)dosomething();if (width =”、“=”、“+”、“*”、“%”、“&”、“|”、“”这类操作符前后不加空格。【建议2-3-1】对于表达式比较长的for 语句和if 语句，为了紧凑起见可以适当地去掉一些空格，如for (i=0; i10; i+)和if (a=b) & (c= 2000) / 良好的风格if(year=2000) / 不良的风格if (a=b) & (c=b&c=d) / 不良的风格for (i=0; i10; i+) / 良好的风格for

12、(i=0;i10;i+) / 不良的风格for (I = 0; I 10; i +) / 过多的空格x = a b ? a : b; / 良好的风格x=aFunction(); / 不要写成b - Function();示例2-3 代码行内的空格2.4 对齐【规则2-4-1】程序的分界符和应独占一行并且位于同一列，同时与引用它们的语句左对齐。【规则2-4-2】 之内的代码块在右边数格处左对齐。void Function(int x) / program codevoid Function(int x) / program codeif (condition) / program codeels

13、e / program codeif (condition) / program codeelse / program codefor (initialization; condition; update) / program codefor (initialization; condition; update) / program codeWhile (condition) / program codewhile (condition) / program code如果出现嵌套的，则使用缩进对齐，如：示例2-4(a) 风格良好的对齐 示例2-4(b) 风格不良的对齐2.5 长行拆分【规则2-

14、5-1】代码行最大长度宜控制在70 至80 个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。【规则2-5-2】长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。if (very_longer_variable1 = very_longer_variable12)& (very_longer_variable3 = very_longer_variable14)& (very_longer_variable5 Draw(); / 类的成员函数【规则3-1-8】用正确的反义词组命名具有互斥意义的变量或相反动

15、作的函数等。例如：int minValue;int maxValue;int SetValue();int GetValue();【建议3-1-1】尽量避免名字中出现数字编号，如Value1,Value2 等，除非逻辑上的确需要编号。这是为了防止程序员偷懒，不肯为命名动脑筋而导致产生无意义的名字（因为用数字编号最省事）。3.2 简单的Windows 应用程序命名规则作者对“匈牙利”命名规则做了合理的简化，下述的命名规则简单易用，比较适合于Windows 应用软件的开发。【规则3-2-1】类名和函数名用大写字母开头的单词组合而成。例如：class Node; / 类名class LeafNode; / 类名void Draw(void); / 函数名void SetValue(int value); / 函数名【规则3-2-2】变量和参数用小写字母开头的单词组合而成。例如：BOOL flag;int drawMode;【规则3-2-3】常量全用大写的字母，用下划线分割单词。例如：const int MAX = 100;const int MAX_LENGTH = 100;【规则3-2-