高质量C++编程之第2章 程序的版式

2.1空行

空行使程序的布局更加清晰。

规则2.1.1：在每个类声明之后、每个函数定义结束之后要加空行。

规则2.1.2：在一个函数体内，逻辑上密切相关的语句之间不加空行，其他地方应加空行分隔。



2.2代码行

规则2.2.1：一行代码只做一件事，如只定义一个变量，或者只写一条语句。这样代码容易阅读，并且方便写注释。（尽可能在定义变量时初始化该变量）

规则2.2.2：if、for、while、do等语句自占一行，执行语句不得紧跟其后。不论语句有多少都要加{ }。



2.3代码行内的空格

规则2.3.1：关键字之后要留空格。像const、virtual、inline、case等关键字之后至少要留一个空格，否则无法辨关键字。像if、for、while等关键字之后应留一个空格再跟左括号“（”，以突出关键字。

规则2.3.2：函数名之后不留空格，紧跟左括号“（”，以与关键字区别。

规则2.3.3：‘（’向后紧跟，‘）’、‘，’‘；’向前紧跟，紧跟处不留空格。

规则2.3.4：‘，’之后要留空格，如functiong(x, y, z)。如果‘；’不是一行的结束符号，其后要留空格，如for (a=0; a<5; a++)。

规则2.3.5：赋值操作符、比较操作符、算术操作符、逻辑操作符、位操作符，如“=”，“>=”,”<=”，“+”等二元操作符的前后应加空格。

规则2.3.6：一元操作符如“！”，“~”，“++”，“–”，“&”等前后不加空格。

规则2.3.7：像“[]”，”.”，“->”，这类操作符前后不加空格。

建议：对于表达式较长的 if 和 for 语句，可适当去掉一些空格。



2.4对齐

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

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



2.5长行拆分

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

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



2.6修饰符的位置

规则2.6.1：应当将修饰符 * 和 & 紧靠变量名。如 char *name; int *x, y; //此处 y 不会被误认为指针。

2.7注释

C++语言中，程序块的注释常采用“/…/”，行注释一般采用“//…”。注释通常用于：

（1）版本、版权声明；

（2）函数接口说明；

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

虽然注释有助于理解代码，但注意不可过多地使用注释。

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

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

规则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）采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么样的接口（或服务）。