
保持外观整洁
|
9
/**************************************************
* This is a pretty comment. *
* Note that there are asterisks on the *
* righthand side of the box. Wow; it looks neat. *
* Hope I never have to fix this tiypo. *
**************************************************/
这条注释看起来很漂亮,但是难于维护。如果你要修改注释,则需要重新对齐注释框的右
边界。坦白地讲,这是一种虐待狂式的排版方式,而选用这种排版方式的程序员并不尊重
同事的时间和精力。(或许他们想把修改这段注释变得极其令人厌烦,这样就没有人敢编
辑他们的注释了。)
2.3
排版
如果一个人想写得清晰,那么他首先应该思路清晰。
——歌德
代码排版的要素包括代码缩进、运算符前后是否加空白、大小写、大括号的位置(可以选
K&R
风格、
Allman
风格、
Whitesmith
风格,或者其他风格),以及争论不休的用“
Tab
还
是
空格”缩进。每个要素都有很多选择,每个选择都有合适的理由。只要你选择的排版方
式能够改善代码的结构,更好地反映你的意图,那就是好的选择。
粗略地看一眼你的代码,如果能够看出代码大概的结构,那就是好的排版。相对于争论
大括号应该放在什么位置,还有很多更重要的排版问题值得考虑。下面的几个方面值得 ...