高质量C/C++编程指南总结（二）—— 文件版式

1. 空行

• 在每个类声明之后、每个函数定义结束之后都要加空行。
  
• 在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。

2. 代码行

• 一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。
• if、 for、 while、 do 等语句自占一行，执行语句不得紧跟其后。不论执行语句有多少都要加{}。这样可以防止书写失误。
• 在定义变量的同时初始化该变量。
  

3. 代码行内的空格

• 关键字之后要留空格。

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

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

如 Function(x, y, z)。如果‘ ;’不是一行的结束符号，其后要留空格，如 for (initialization; condition; update)。

• 赋值操作符、比较操作符、算术操作符、逻辑操作符、位域操作符，如“ =”、 “ +=” “ >=”、 “ <=”、 “ +”、 “ *”、 “ %”、 “ &&”、 “ ||”、 “ <<” ,“ ^”等二元操作符的前后应当加空格。
• 一元操作符如“ !”、“ ~”、“ ++”、“ --”、“ &”（地址运算符）等前后不加空格。
  
• 像“［］”、 “ .”、 “ ->”这类操作符前后不加空格。
• 对于表达式比较长的 for 语句和 if 语句，为了紧凑起见可以适当地去掉一些空格。

如 for (i=0; i<10; i++)和 if ((a<=b) && (c<=d))

4. 对齐

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

5. 长行拆分

• 代码行最大长度宜控制在 70 至 80 个字符以内。代码行不要过长。
• 长表达式要在低优先级操作符处拆分成新行， 操作符放在新行之首（以便突出操作符）。拆分出的新行要进行适当的缩进，使排版整齐，语句可读。
  

6. 修饰符的位置

• 将修饰符 * 和 & 紧靠变量名。

7. 注释

• 注释是对代码的“提示”，而不是文档。注释花样要少。
  
• 边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。
• 注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。
• 避免在注释中使用缩写，特别是不常用缩写。
  
• 注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。
• 当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注释，便于阅读。
  

8. 类的板式

• 建议采用“以行为为中心”的书写方式编写类。
  
  • 将 public 类型的函数写在前面，而将 private 类型的数据写在后面，采用这种版式的程序员主张类的设计“以行为为中心”，重点关注的是类应该提供什么
    样的接口（或服务）。
  • 将 private 类型的数据写在前面， 而将 public 类型的函数写在后面， 采用这种版式的程序员主张类的设计“以数据为中心”，重点关注类的内部结构。