高质量C/C++编程指南（一）

不知道大家之前的评分怎样，无论如何好的写作规范方便了自己，也会方便以后看代码的人。以下的写作规范源自 林锐的《高质量C++/C编程指南。

    第一章 文件结构

1.1 版权和版本的声明

/* 
* Copyright (c) 2001,上海贝尔有限公司网络应用事业部 
* All rights reserved. 
* 
* 文件名称: filename.h 
* 文件标识: 见配置管理计划书 
* 摘 要: 简要描述本文件的内容 
* 
* 当前版本: 1.1 
* 作 者: 输入作者(或修改者)名字 
* 完成日期: 2001年7月20日 
* 
* 取代版本:1.0 
* 原作者 
: 输入原作者(或修改者)名字 
* 完成日期: 2001年5月10日 
*/

1.2 头文件的结构

头文件由三部分内容组成:
(1)头文件开头处的版权和版本声明 。
(2)预处理块。
(3)函数和类结构声明等。
在 C++ 语法中,类的成员函数可以在声明的同时被定义,并且自动成为内联函数。
这虽然会带来书写上的方便,但却造成了风格不一致,弊大于利。建议将成员函数的定义与声明分开,不论该函数体有多么小。
【规则 1-2-1】为了防止头文件被重复引用,应当用
ifndef/define/endif 结构产生预处 理块。
【规则 1-2-2】用#include <filename.h> 格式来引用标准库的头文件(编译器将从 标准库目录开始搜索) 。
【规则 1-2-3】用 #include “filename.h” 格式来引用非标准库的头文件(编译器将 从用户的工作目录开始搜索) 。

1.3 头文件的作用

早期的编程语言如 Basic、Fortran 没有头文件的概念,C++/C 语言的初学者虽然会用使用头文件,但常常不明其理。这里对头文件的作用略作解释:
(1)通过头文件来调用库功能。在很多场合,源代码不便(或不准)向用户公布,只要向用户提供头文件和二进制的库即可。用户只需要按照头文件中的接口声明来调用库功能,而不必关心接口怎么实现的。编译器会从库中提取相应的代码。
(2)头文件能加强类型安全检查。如果某个接口被实现或被使用时,其方式与头文件中的声明不一致,编译器就会指出错误,这一简单的规则能大大减轻程序员调试、改错的负担。

1.4 目录结构

如果一个软件的头文件数目比较多(如超过十个),通常应将头文件和定义文件分别保存于不同的目录,以便于维护。
例如可将头文件保存于 include 目录,将定义文件保存于 source 目录(可以是多级目录)。
如果某些头文件是私有的,它不会被用户的程序直接引用,则没有必要公开其“声明”。为了加强信息隐藏,这些私有的头文件可以和定义文件存放于同一个目录。

第二章 程序的版式

版式虽然不会影响程序的功能,但会影响可读性。程序的版式追求清晰、美观,是程序风格的重要构成因素。可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然,看得兴致勃勃。差的程序“书法”如螃蟹爬行,让人看得索然无味,更令维护者烦恼有加。请程序员们学习程序的“书法”,弥补大学计算机教育的漏洞,实在很有必要。

2.1 空行

空行起着分隔程序段落的作用。空行得体(不过多也不过少)将使程序的布局更加清晰。空行不会浪费内存,虽然打印含有空行的程序是会多消耗一些纸张,但是值得。所以不要舍不得用空行。
【规则 2-1-1】在每个类声明之后、每个函数定义结束之后都要加空行。
【规则 2-1-2】在一个函数体内,逻揖上密切相关的语句之间不加空行,其它地方应加空行分隔

2.2 代码行

【规则2-2-1】一行代码只做一件事情,如只定义一个变量,或只写一条语句。这样的代码容易阅读,并且方便于写注释。
【规则 2-2-2】if、for、while、do 等语句自占一行,执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写误。
【建议 2-2-1】尽可能在定义变量的同时初始化该变量(就近原则)
如果变量的引用处和其定义处相隔比较远,变量的初始化很容易被忘记。如果引用了未被初始化的变量,可能会导致程序错误。本建议可以减少隐患。

2.3 代码行内的空格

【规则 2-3-1】关键字之后要留空格。像 const、virtual、inline、case 等关键字之后至少要留一个空格,否则无法辨析关键字。象 if、for、while 等关键字之后应留一个空格再跟左括号(‘ ,以突出关键字。
【规则 2-3-2】函数名之后不要留空格,紧跟左括号 (’‘ ,以与关键字区别。
【规则 2-3-3】 (’向后紧跟 ‘) , ’ ‘, 、 ’ ‘;’向前紧跟,紧跟处不留空格。
【规则 2-3-4】‘， ’之后要留空格,如 Function(x, y, z)。如果‘;’不是一行的结束符号,其后要留空格,如 for (initialization; condition; update)。
【规则 2-3-5】赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符,如“=” “+=” “>=” “<=” “+” “*” “%” “&&” “||” “<<”,“^”等二元操作符的前后应当加空格。
【规则 2-3-6】一元操作符如“!” “~”“++”“–”“&”(地址运算符)等前后不加空格。
【规则 2-3-7】象“[] ” “.” “->”这类操作符前后不加空格。
【建议 2-3-1】对于表达式比较长的 for 语句和 if 语句,为了紧凑起见可以适当地去掉一些空格,如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))

void Func1(int x, int y, int z); // 良好的风格
void Func1 (int x,int y,int z); // 不良的风格

if (year >= 2000) // 良好的风格
if(year>=2000) // 不良的风格

if ((a>=b) && (c<=d)) // 良好的风格
if(a>=b&&c<=d) // 不良的风格

for (i=0; i<10; i++) // 良好的风格
for(i=0;i<10;i++) // 不良的风格
for (i = 0; I < 10; i ++) // 过多的空格

x = a < b ? a : b; // 良好的风格
x=a<b?a:b; // 不好的风格

int *x = &y; // 良好的风格
int * x = & y; // 不良的风格

array[5] = 0; // 不要写成 array [ 5 ] = 0;
a.Function(); // 不要写成 a . Function();
b->Function(); // 不要写成 b -> Function();

2.4 对齐

【规则 2-4-1】程序的分界符‘{’和‘}’应独占一行并且位于同一列,同时与引用它们的语句左对齐。
【规则 2-4-2】{ }之内的代码块在‘{’右边数格处左对齐。

2.5 长行拆分

【规则 2-5-1】代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长,否则眼睛看不过来,也不便于打印。
【规则 2-5-2】长表达式要在低优先级操作符处拆分成新行,
操作符放在新行之首(以便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

if ((very_longer_variable1 >= very_longer_variable12)
    && (very_longer_variable3 <= very_longer_variable14)
    && (very_longer_variable5 <= very_longer_variable16))
{
dosomething();
}
virtual CMatrix CMultiplyMatrix (CMatrix leftMatrix,
                                CMatrix rightMatrix);
for (very_longer_initialization;
    very_longer_condition;
    very_longer_update)
{
dosomething();
}

2.6 修饰符的位置

修饰符 * 和 & 应该靠近数据类型还是该靠近变量名,是个有争议的活题。
若将修饰符 * 靠近数据类型,例如:int*x; 从语义上讲此写法比较直观,即 x是 int 类型的指针。上述写法的弊端是容易引起误解,例如:int* x, y; 此处 y 容易被误解为指针变量。虽然将 x 和 y 分行定义可以避免误解,但并不是人人都愿意这样做。
【规则 2-6-1】应当将修饰符 * 和 & 紧靠变量名

2.7 注释

C 语言的注释符为“/…/”。C++语言中,程序块的注释常采用“/…/”,行注释一般采用“//…”。注释通常用于:
(1)版本、版权声明;
(2)函数接口说明;
(3)重要的代码行或段落提示。
虽然注释有助于理解代码,但注意不可过多地使用注释。参见示例
【规则 2-7-1】注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,注释太多了会让人眼花缭乱。注释的花样要少。
【规则 2-7-2】如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。例如 i++;// i 加 1,多余的注释
【规则 2-7-3】边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
【规则 2-7-4】注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而有害。
【规则 2-7-5】尽量避免在注释中使用缩写,特别是不常用缩写。
【规则 2-7-6】注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不可放在下方。
【规则 2-7-8】当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注释,便于阅读。

2.8 类的版式

类可以将数据和函数封装在一起,其中函数表示了类的行为(或称服务)。类提供关键字 public、protected 和 private,分别用于声明哪些数据和函数是公有的、受保护的或者是私有的。这样可以达到信息隐藏的目的,即让类仅仅公开必须要让外界知道的内容,而隐藏其它一切内容。我们不可以滥用类的封装功能,不要把它当成火锅,什么东西都往里扔。
类的版式主要有两种方式:
(1)将 private 类型的数据写在前面,而将 public 类型的函数写在后面,如示例 8-3(a)采用这种版式的程序员主张类的设计“以数据为中心”,重点关注类的内部结构。
(2)将 public 类型的函数写在前面,而将 private 类型的数据写在后面,如示例 8.3(b)采用这种版式的程序员主张类的设计“以行为为中心” 重点关注的是类应该提供什么样,的接口(或服务)。
很多 C++教课书受到 Biarne Stroustrup 第一本著作的影响,不知不觉地采用了“以
数据为中心”的书写方式,并不见得有多少道理。
我建议读者采用“以行为为中心”的书写方式,即首先考虑类应该提供什么样的函数。这是很多人的经验——“这样做不仅让自己在设计类时思路清晰,而且方便别人阅读。因为用户最关心的是接口,谁愿意先看到一堆私有数据成员!”