《高质量C/C++编程指南》第1期

一、前言

二、文件结构

1.版权和版本的声明

2.头文件的结构

3.定义文件的结构

4.头文件的作用

5.目录结构

三、程序的版式

1.空行

2.代码行

3.代码行内的空格

4.对齐

5.长行拆分

6.修饰符的位置

7.注释

8.累的版式

一、前言

这一个分栏是关于如何在编程的过程中写出更加优质的代码，希望对大家有所帮助。

码字不易，还请三连支持。有了你们的支持，我定将能写出更好的文章！

二、文件结构

每个 C++/C 程序通常分为两个文件。一个文件用于保存程序的声明（ declaration ），

称为头文件。另一个文件用于保存程序的实现（ implementation ），称为定义（ definition ）

文件。

C++/C 程序的头文件以“ .h ”为后缀， C 程序的定义文件以“ .c ”为后缀， C++ 程序

的定义文件通常以“ .cpp ”为后缀（也有一些系统以“ .cc ”或“ .cxx ”为后缀）。

1.版权和版本的声明

版权和版本的声明位于头文件和定义文件的开头（参见示例 1-1 ），主要内容有：

（ 1 ）版权信息。

（ 2 ）文件名称，标识符，摘要。

（ 3 ）当前版本号，作者 / 修改者，完成日期。

（ 4 ）版本历史信息。

2.头文件的结构

头文件由三部分内容组成：

（ 1 ）头文件开头处的版权和版本声明（参见示例 1-1 ）。

（2）预处理块。

（3）函数和类结构声明等。

假设头文件名称为 graphics.h，头文件的结构参见示例 1-2 。

⛳ 【规则 1 】

为了防止头文件被重复引用，应当用 ifndef/define/endif 结构产生预

处理块。

⛳ 【规则 2】

用 #include < filename.h> 格式来引用标准库的头文件（编译器将

从标准库目录开始搜索）。

⛳ 【规则 3 】

用 #include “filename.h” 格式来引用非标准库的头文件（编译器将

从用户的工作目录开始搜索）。

⭐ 【建议 1】

头文件中只存放“声明”而不存放“定义”

在 C++ 语法中，类的成员函数可以在声明的同时被定义，并且自动成为内联函数。

这虽然会带来书写上的方便，但却造成了风格不一致，弊大于利。建议将成员函数的定

义与声明分开，不论该函数体有多么小。

⭐ 【建议 2】

不提倡使用全局变量，尽量不要在头文件中出现象 extern int value 这

类声明。

3.定义文件的结构

定义文件有三部分内容：

（ 1 ）定义文件开头处的版权和版本声明（参见示例 1-1 ）。

（2）对一些头文件的引用。

（3）程序的实现体（包括数据和代码）。

假设定义文件的名称为 graphics.cpp，定义文件的结构参见示例 1-3 。

4.头文件的作用

早期的编程语言如 Basic 、 Fortran 没有头文件的概念，C/ C++ 语言的初学者虽然会

用使用头文件，但常常不明其理。这里对头文件的作用略作解释：

（ 1 ）通过头文件来调用库功能。在很多场合，源代码不便（或不准）向用户公布，只

要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库

功能，而不必关心接口怎么实现的。编译器会从库中提取相应的代码。

（2）头文件能加强类型安全检查。如果某个接口被实现或被使用时，其方式与头文件

中的声明不一致，编译器就会指出错误，这一简单的规则能大大减轻程序员调试、改错

的负担。

5.目录结构

如果一个软件的头文件数目比较多（如超过十个），通常应将头文件和定义文件分

别保存于不同的目录，以便于维护。

例如可将头文件保存于 include 目录，将定义文件保存于 source 目录（可以是多级

目录）。

如果某些头文件是私有的，它不会被用户的程序直接引用，则没有必要公开其“声

明”。为了加强信息隐藏，这些私有的头文件可以和定义文件存放于同一个目录。

三、程序的版式

1.空行

空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加

清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。

所以不要舍不得用空行。

⛳ 【规则 1 】

在每个类声明之后、每个函数定义结束之后都要加空行。参见示例 2-1（a）

⛳ 【规则 2 】

在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。

参见示例 2- （ b ）

2.代码行

⛳ 【规则 1 】

一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样

的代码容易阅读，并且方便于写注释。

⛳ 【规则 2 】

if 、 for 、 while 、 do 等语句自占一行，执行语句不得紧跟其后。不论

执行语句有多少都要加 {} 。这样可以防止书写失误。

示例 2-2 （ a ）为风格良好的代码行，

示例 2-2 （ b ）为风格不良的代码行。

⭐ 【建议 1 】

尽可能在定义变量的同时初始化该变量（就近原则）

如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用

了未被初始化的变量，可能会导致程序错误。本建议可以减少隐患。

例如

int width = 10; // 定义并初绐化 width

int height = 10; // 定义并初绐化 height

int depth = 10; // 定义并初绐化 depth

3.代码行内的空格

⛳ 【规则 1 】

关键字之后要留空格。象 const 、 virtual 、 inline 、 case 等关键字之

后至少要留一个空格，否则无法辨析关键字。象 if 、 for 、 while 等关键字之后应留

一个空格再跟左括号‘（’，以突出关键字。

⛳ 【规则 2 】

函数名之后不要留空格，紧跟左括号‘（’，以与关键字区别。

⛳ 【规则 3 】

‘（’ 向后紧跟，‘）’、‘，’、‘;’ 向前紧跟，紧跟处不留空格。

⛳ 【规则 4 】

‘，’之后要留空格，如 Function(x, y, z) 。如果 ‘;’ 不是一行的结束

符号，其后要留空格，如 for (initialization; condition; update)。

⛳ 【规则 5 】

赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，

如“ = ”、“ += ” “ >= ”、“ <= ”、“ + ”、“ * ”、“ % ”、“ && ”、“ || ”、“ << ” , “ ^ ”等二

元操作符的前后应当加空格。

⛳ 【规则 6 】

一元操作符如“!”、“ ~ ”、“ ++ ”、“ -- ”、“ & ”（地址运算符）等前后不

加空格。

⛳ 【规则 7 】

像“［］”、“.”、“->”这类操作符前后不加空格。

⭐ 【建议 1 】

对于表达式比较长的 for 语句和 if 语句，为了紧凑起见可以适当地去

掉一些空格，如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))

4.对齐

⛳ 【规则 2-4-1 】

程序的分界符 ‘{’ 和 ‘}’ 应独占一行并且位于同一列，同时与引用它们的语句左对齐。

⛳ 【规则 2-4-2 】

{ } 之内的代码块在 ‘{’ 右边数格处左对齐。

示例 2-4 （a）为风格良好的对齐

void Function(int x)
{
… // program code
}
if (condition)
{
… // program code
}
else
{
… // program code
}
for (initialization; condition; update)
{
… // program code
}
While (condition)
{
… // program code
}
如果出现嵌套的｛｝，则使用缩进对齐，如：
{
…
{
…
}
…
}

示例 2-4 （ b ）为风格不良的对齐

void Function(int x){
… // program code
}
if (condition){
… // program code
}
else {
… // program code
}
for (initialization; condition; update){
… // program code
}
while (condition){
… // program code
}

5.长行拆分

⛳ 【规则 1 】

代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长，否

则眼睛看不过来，也不便于打印。

⛳ 【规则 2 】

长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以

便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

6.修饰符的位置

修饰符 * 和＆应该靠近数据类型还是该靠近变量名，是个有争议的活题。

若将修饰符 * 靠近数据类型，例如：int* x; 从语义上讲此写法比较直观，即 x

是 int 类型的指针。

上述写法的弊端是容易引起误解，例如：int* x, y; 此处 y 容易被误解为指针变

量。虽然将 x 和 y 分行定义可以避免误解，但并不是人人都愿意这样做。

⛳ 【规则 1 】

应当将修饰符 * 和＆紧靠变量名

例如：

char *name;

int *x, y; // 此处 y 不会被误解为指针

7.注释

C 语言的注释符为“ /*…*/ ”。 C++ 语言中，程序块的注释常采用“ /*…*/ ”，行注释

一般采用“ //… ”。注释通常用于：

（ 2 ）函数接口说明；

（ 3 ）重要的代码行或段落提示。

虽然注释有助于理解代码，但注意不可过多地使用注释。参见示例 2-6 。

⛳ 【规则 1 】

注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，

注释太多了会让人眼花缭乱。注释的花样要少。

⛳ 【规则 2 】

如果代码本来就是清楚的，则不必加注释。否则多此一举，令人厌烦。

例如:

i++; // i 加 1，多余的注释

⛳ 【规则 3 】

边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码

的一致性。不再有用的注释要删除。

⛳ 【规则 4 】

注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而

有害。

⛳ 【规则 5 】

尽量避免在注释中使用缩写，特别是不常用缩写。

⛳ 【规则 6 】

注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不

可放在下方。

⛳ 【规则 8 】

当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注

释，便于阅读。

示例 2-6 程序的注释

/*

* 函数介绍：

* 输入参数：

* 输出参数：

* 返回值：

*/

void Function(float x, float y, float z)

{

…

}

if (…)

{

…

while (…)

{

…

} // end of while

…

} // end of if

8.累的版式

类可以将数据和函数封装在一起，其中函数表示了类的行为（或称服务）。类提供

关键字 public 、 protected 和 private ，分别用于声明哪些数据和函数是公有的、受保护

的或者是私有的。这样可以达到信息隐藏的目的，即让类仅仅公开必须要让外界知道的

内容，而隐藏其它一切内容。我们不可以滥用类的封装功能，不要把它当成火锅，什么

东西都往里扔。

类的版式主要有两种方式：

（ 1 ）将 private 类型的数据写在前面，而将 public 类型的函数写在后面，如示例 8-3 （ a ）。

采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构。

（ 2 ）将 public 类型的函数写在前面，而将 private 类型的数据写在后面，如示例 8.3 （ b ）

采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么

样的接口（或服务）。

很多 C++ 教课书受到 Biarne Stroustrup 第一本著作的影响，不知不觉地采用了“以

数据为中心”的书写方式，并不见得有多少道理。

我建议读者采用“以行为为中心”的书写方式，即首先考虑类应该提供什么样的函

数。这是很多人的经验——“这样做不仅让自己在设计类时思路清晰，而且方便别人阅

读。因为用户最关心的是接口，谁愿意先看到一堆私有数据成员！”