C语言中的对齐，长行拆分，修饰符的位置，注释

*内容节选自林锐的《高质量的C-C＋＋编程》

（1）对齐

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

【规则 1-2】 { }之内的代码块在‘ {’右边数格处左对齐

---

（2）长行拆分

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

---

（3）修饰符的位置

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

【规则3-1】应当将修饰符*和&紧靠变量名

---

（4）注释

C 语言的注释符为“ /*…*/”。 C++语言中，程序块的注释常采用“ /*…*/”，行注释
一般采用“ //…”。注释通常用于：
（ 1）版本、版权声明；
（ 2）函数接口说明；
（ 3）重要的代码行或段落提示。
虽然注释有助于理解代码，但注意不可过多地使用注释。

参见示例 ：

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

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

【规则 4-3】边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码
的一致性。不再有用的注释要删除。
【规则 4-4】注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而
有害。
【规则 4-5】尽量避免在注释中使用缩写，特别是不常用缩写。
【规则 4-6】注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不
可放在下方。
【规则 4-8】当代码比较长，特别是有多重嵌套时，应当在一些段落的结束处加注
释，便于阅读。