《代码整洁之道》——(4)格式
目录
先明确一下,代码格式很重要。代码格式不可忽略,必须严肃对待。代码格式关乎沟通,而沟通是专业开发者的头等大事。
4.2、垂直格式
短文件通常比长文件易于理解。
4.2.1、向报纸学习
源文件要像报纸文章那样。名称应当简单且一目了然。名称本身应该足够告诉我们是否在正确的模块。源文件最顶部应该给出高层次概念和算法。细节应该渐次展开,直至找到源文件中最底层的函数和细节。
4.2.2、概念间垂直方向上的区隔
几乎所有的代码都是从上往下读,从左往右读。每行展现一个表达式或一个子句,每组代码行展示一条完整的思路。这些思路用空白行区隔开来。
每个空白行都是一条线索,标识出新的独立概念。往下读代码时,你的目光总会停留于空白行之后的那一行。
4.2.3、垂直方向上的靠近
如果说空白行隔开了概念,靠近的代码行则暗示了它们之间的紧密关系。所以紧密相关的代码应该互相靠近。
4.2.4、垂直距离
关系密切的概念应该互相靠近。显然,这条规则并不适用于分布在不同文件中的概念。除非有很好的理由,否则就不要把关系密切的概念放到不同的文件中。实际上,这也是避免使用protected变量的理由之一。
对于那些关系密切、放置于同一源文件中的概念,它们之间的区隔应该成为对相互的易懂度有多重要的标准。应避免迫使读者在源文件和类中跳来跳去。
变量声明。变量声明应尽量尽可能靠近其使用位置。因为函数很短,本地变量应该在函数顶部出现。
循环中的控制变量应该总是在循环语句中声明。
实体变量应该在类的顶部声明。这应该不会增加变量的垂直距离,因为在设计良好的类中,它们如果不是被该类的所有方法也是被大多数方法所用。
相关函数。若某个函数调用了另外一个,就应该把它们放到一起,而且调用者应该尽可能放在被调用者上面。这样,程序就有个自然顺序。
概念相关。概念相关的代码应该放到一起。相关性越强,彼此之间的距离就该越短。
4.3、横向格式
4.3.1、水平方向上的区隔与靠近
我们使用空格字符将彼此紧密相关的事物连接到一起,也用空格字符把相关性较弱的事物分隔开。
在赋值操作符周围加上空格,以此达到强调目的。
4.3.2、水平对齐
源文件是一种继承结构,而不是一种大纲结构。其中的信息涉及整个文件、文件中每个类、类中的方法、方法中的代码块,也涉及代码块中的代码。这种继承结构中的每一层级都圈出一个范围,名称可以
在其中声明,而声明和执行语句也可以在其中解释。
要让这种范围式继承结构可见,我们依源代码行在继承结构中的位置对源代码行做缩进处理。在文件顶层的语句,例如大多数的类声明,根本不缩进。类中的方法相对该类缩进一个层级。方法的实现相对方法
声明缩进一个层级。代码块的实现相对于其容器代码块缩进一个层级,以此类推。
4.4、团队规则
好的软件系统是由一系列读起来不错的代码文件组成的。它们需要拥有一致和顺畅的风格。读者要能确信,他们在一个源文件中看到的格式风格在其他文件中也是同样的用法。
绝对不要用各种不同的风格来编写源代码,这样会增加其复杂度。