第二章 程序的板式

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 关键字之后要留空格。
规则 2-3-2 函数名之后不要留空格,紧跟左括号。
规则 2-3-3 '(' 向后紧跟, ')'、','、';'向前紧跟,紧跟处不留空格。
规则 2-3-4 ','之后要留空格,如果';'不是一行的结束符合,其后留空格。
规则 2-3-5 赋值操作符、比较操作符、算数操作符、逻辑操作符、位域操作符等二元操作符的前后应当加空格。
规则 2-3-6 一元操作符如"++"、"!"等前后不加空格。
规则 2-3-7 像"[]"、"."、"->"这类操作符前后不加空格。
建议 2-3-1 对于表达式比较长的for语句和if语句,为了紧凑起见可以适当地去掉一些空格。

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

2.5 长行拆分
规则 2-5-1 代码行最大长度宜控制在70到80个字符以内。
规则 2-5-2 长表达式要在低优先级操作符处拆分成新行,操作符放在新行之首(以
便突出操作符)。拆分出的新行要进行适当的缩进,使排版整齐,语句可读。

2.6 修饰符的位置
规则 2-6-1 应当将修饰符 * 和&紧靠变量名

2.7 注释
规则2-7-1 注释是对代码的“提示”,而不是文档。程序中的注释不可喧宾夺主,
注释太多了会让人眼花缭乱。注释的花样要少。
规则2-7-2 如果代码本来就是清楚的,则不必加注释。否则多此一举,令人厌烦。
规则2-7-3 边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码
的一致性。
规则2-7-4 注释应当准确、易懂,防止注释有二义性。错误的注释不但无益反而
有害。
规则2-7-5 尽量避免在注释中使用缩写,特别是不常用缩写。
规则2-7-6 注释的位置应与被描述的代码相邻,可以放在代码的上方或右方,不
可放在下方。
规则2-7-8 当代码比较长,特别是有多重嵌套时,应当在一些段落的结束处加注
释,便于阅读。

2.8 类的版式
推荐将public类型的函数写在前面,而将private类型的数据写在后面。重点关注的是类应该提供什么样的接口(或服务)。

你可能感兴趣的:(第二章 程序的板式)