《代码整洁之道》第 5 章 格式
第 5 章 格式
5.2 垂直格式
Junit、FitNesse 和 Time and Money由 相对较小的文件组成。没有一个超过 500 行，多数都小于 200 行。Tomcat 和 Ant 则有些文件达到数千行，将近一半文件长于 200 行。
对我们来说，这意味着什么？意味着有可能用大多数为 200 行、最长 500 行的单个文件构造出色的系统(FitNesse 总长约 50000 行)。尽管这并非不可违背的则，也应该乐于接受。短文件通常比长文件易于理解。
5.2.1 向报纸学习
源文件也要像报纸文章那样。名称应当简单且一目了然。名称本身应该足够告诉我们是否在正确的模块中。源文件最顶部应该给出高层次概念和算法。细节应该往下渐次展开，直至找到源文件中最底层的函数和细节。
5.2.2 概念间垂直方向上的区隔
在封包声明、导入声明和每个函数之间，都有空白行隔开。这条极其简单的规则极大地影响到代码的视觉外观。每个空白行都是一条线索， 标识出新的独立概念。往下读代码时，你的目光总会停留于空白行之后那一行。
5.2.3 垂直方向上的靠近
如果说空白行隔开了概念，靠近的代码行则暗示了它们之间的紧密关系。所以，紧密相关的代码应该互相靠近。
5.2.4 垂直距离
对于那些关系密切、放置于同一源文件中的概念，它们之间的区隔应该成为对相互的易懂度有多重要的衡量标准。应避免迫使读者在源文件和类中跳来跳去。
变量声明。变量声明应尽可能靠近其使用位置。因为函数很短，本地变量应该在函数的顶部出现。
-
循环中的控制变量应该总是在循环语句中声明。
-
偶尔，在较长的函数中，变量也可能在某个代码块顶部，或在循环之前声明。
-
实体变量应该在类的顶部声明。这应该不会增加变量的垂直距离，因为在设计良好的类中，它们如果不是被该类的所有方法也是被大多数方法所用。
相关函数。若某个函数调用了另外一个，就应该把它们放到一起，而且调用者应该尽可能放在被调用者上面。这样，程序就有个自然的顺序。若坚定地遵循这条约定，读者将能够确信函数声明总会在其调用后很快出现。
如上所述，相关性应建立在直接依赖的基础上，如函数间调用，或函数使用某个变量。但也有其他相关性的可能。相关性可能来自于执行相似操作的一组函数。请看以下来自 Junit 4.3.1的代码片段:
public class Assert {
static public void assertTrue (String message, iboolean condition) {
if (!condition)
fail(message) ;
}
static public void assertTrue (boolean condition) {
assertTrue(null, condition) ;
}
static public void assertFalse (String message, boolean condition) {
assertTrue(message, !condition) ;
}
static public void assertFalse (boolean condition) {
assertFalse(null, condition) ;
}
这些函数有着极强的概念相关性，因为他们拥有共同的命名模式，执行同一个基础任务的不同变种。互相调用是第二位的。即便没有互相调用，也应该放在一起。
5.2.5 垂直顺序
一般而言，我们想自上向下展示函数调用依赖顺序。也就是说，被调用的函数应该放在执行调用的函数下面。这样就建立了一种自顶向下贯穿源代码模块的良好信息流。
像报纸文章一般，我们指望最重要的概念先出来，指望以包括最少细节的方式表述它们。我们指望底层细节最后出来。这样，我们就能扫过源代码文件，自最前面的几个函数获知要旨，而不至于沉溺到细节中。
5.3 横向格式
5.3.1 水平方向上的区隔与靠近
赋值语句有两个确定而重要的要素：左边和右边。空格字符加强了分隔效果。
不在函数名和左圆括号之间加空格。这是因为函数与其参数密切相关，如果隔开，就会显得互无关系。把函数调用括号中的参数一一隔开，强调逗号，表示参数是互相分离的。
空格字符的另一种用法是强调前面的运算符：乘法因子之间没加空格，因为它们具有较高优先级。加减法运算项之间用空格隔开，因为加法和减法优先级较低。
5.3.4 空范围
有时，while 或 for 语句的语句体为空，如下所示。我不喜欢这种结构，尽量不使用。如果无法避免，就确保空范围体的缩进，用括号包围起来。我无法告诉你，我曾经多少次被静静安坐在与 while 循环语句同一行末尾的分号所欺骗。除非你把那个分号放到另一行再加以缩进，否则就很难看到它。
while (dis. read (buf, 0，readBufferSize) != -1)
;
