文档介绍：C++代码规范
2006年5月2日
目录
第1章文件结构 1
1
头文件的结构 1
定义文件的结构 2
目录结构 3
第2章程序的版式 4
空行 4
代码行 4
代码行内的空格 5
对齐 6
长行拆分 7
修饰符的位置 8
注释 8
类的版式 10
第3章命名规则 11
第4章表达式和基本语句 14
运算符的优先级 14
复合表达式 14
if 语句 15
循环语句的效率 16
for 语句的循环控制变量 16
switch语句 17
goto语句 17
第5章常量 18
18
常量定义规则 18
类中的常量 19
第6章函数设计 20
参数的规则 20
返回值的规则 21
函数内部实现的规则 21
其它建议 22
使用断言 23
附录A :C++/C代码审查表 25
第1章文件结构
每个C++程序通常分为两个文件。一个文件用于保存程序的声明(declaration),称为头文件。另一个文件用于保存程序的实现(implementation),称为定义(definition)文件。
C++程序的头文件以“.h”为后缀,定义文件以“.cpp”为后缀。一般每个类有单独的头文件和定义文件,文件名与类名相同(不包括类名的第一个字母’C’)。紧密关系的类可以放在同一套文件中,如容器类和它的选代器。
头文件的声明描述了文件和文件踪迹变化,位于头文件和定义文件的开头(参见示例1-1),主要内容有:
(1)公司名称
(2)文件名称,主要功能(摘要)。
(3)作者/修改者,完成日期。
(4)版本历史信息。
/**
* ***@file filename
* 文件的简要说明,一般说明此文件实现/定义哪个类即可.
* 文件的详细说明,可省略。
* ***@author 作者
* 公司名:××公司
* 修改历史:(受控后每次修改)
* 20080614 XXX 创建该文件
*/
示例1-1 版权和版本的声明
头文件的结构
头文件由三部分内容组成:
(1)头文件开头处的版权和版本声明(参见示例1-1)。
(2)预处理块。
(3)函数和类结构声明等。
假设头文件名称为 ,头文件的结构参见示例1-2。
【规则1-2-1】为了防止头文件被重复引用,应当用ifndef/define/endif结构产生预处理块。
【规则1-2-2】用#include <> 格式来引用标准库的头文件(编译器将从标准库目录开始搜索)。
【规则1-2-3】用#include “”格式来引用非标准库的头文件(编译器将从用户的工作目录开始搜索)。
【建议1-2-1】头文件中只存放“声明”而不存放“定义”
在C++ 语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。将成员函数的定义与声明分开,不论该函数体有多么小。inline函数可以写在头文件中,但要与类的声明分开。
【建议1-2-2】不提倡使用全局变量,尽量不要在头文件中出现象extern int value 这类声明。
// 版权和版本声明见示例1-1,此处省略。
#ifndef _GRAPHICS_H //
// 手工书写时使用大写的头文件名前面加下划线,
// 也可由工具自动产生
#define _GRAPHICS_H
#include <> // 引用标准库的头文件
…
#include “”// 引用非标准库的头文件
…
void Function1(…); // 全局函数声明
…
class CGraphics // 类结构声明
{
…
};
#endif
示例1-2 C++/C头文件的结构
定义文件的结构
定义文件有三部分内容:
定义文件开头处的版权和版本声明(参见示例1-1)。
对一些头文件的引用(系统头文件的引用必须使用相同的顺序)。
程序的实现体(包括数据和代码)。
假设定义文件的名称为 ,定义文件的结构参见示例1-3。
// 版权和版本声明见示例1-1,此处省略。
#include “” // 引用头文件
…
// 全局函数