第二章 高质量C编程规范程序的版式

1.空行

空行不会浪费内存，在适当的地方加上空行会提高程序的可读性。

（1）在每个类声明之后、每个函数定义结束之后都要加空行。

（2）在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。比如变量定义后，if语句之后等。

2.代码行

（1）一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。

例如：int width;

     int length;

（2）if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。

建议：尽可能在定义变量的同时初始化该变量（就近原则）。如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。

3.代码行中的空格

（1）关键字之后要留空格。象const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨析关键字。象if、for、while等关键字之后应留一个空格再跟左括号‘（’，以突出关键字。

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

（3）‘（’向后紧跟（如int add（int a， int b）中‘（’和inta之间没有空格）。‘）’、‘，’、‘;’向前紧跟，紧跟处不留空格。

（4）赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“=”、“+=”“>=”、“<=”、“+”、“*”、“%”、“&&”、“||”、“<<”,“^”等二元操作符的前后应当加空格。

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

加空格。

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

建议：对于表达式比较长的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();

4.对齐

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

（2）{ }之内的代码块在‘{’右边数格（一般取得一个Tab键的宽度即可）处左对齐。

5.长行拆分

（1）代码行最大长度宜控制在70 至80个字符以内。代码行不要过长，否则眼睛看不过来，也不便于打印。

（2）长表达式要在低优先级操作符处拆分成新行，操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。

示例：

if ((very_longer_variable1 >=very_longer_variable12)

   && (very_longer_variable3<= very_longer_variable14)

   && (very_longer_variable5<= very_longer_variable16))

{

   dosomething();

}

 

virtual CMatrix CMultiplyMatrix (CMatrixleftMatrix,

                                CMatrix rightMatrix);

 

for (very_longer_initialization;

    very_longer_condition;

    very_longer_update)

{

    dosomething();

}

6.修饰符的位置

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

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

7.注释

（1）注释是对代码的“提示”，而不是文档。程序中的注释不可喧宾夺主，注释太多了会让人眼花缭乱。注释的花样要少。

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

（3）边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。

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

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

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

（7）当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。

建议：对于一个函数的注释，可以采取下面这几个部分的注释。

 

8.类的版式

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

（1）将private 类型的数据写在前面，而将public类型的函数写在后面，如示例8-3（a）。采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构。

（2）将public 类型的函数写在前面，而将private类型的数据写在后面，如示例8.3（b）采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么样的接口（或服务）。

建议：建议读者采用“以行为为中心”的书写方式，即首先考虑类应该提供什么样的函数。这是很多人的经验——“这样做不仅让自己在设计类时思路清晰，而且方便别人阅读。因为用户最关心的是接口，谁愿意先看到一堆私有数据成员！”