代码整洁之道-第五章 格式

第五章 格式

5.1格式目的

让代码更可读

5.2垂直格式

1、对于单个文件（或者类）来说，行数最好在200行左右，最大不要超过500行，以便于理解与阅读。

2、一般阅读习惯为从上至下，当在文件顶端，应该像阅读报纸一样，注明文件大纲即可，而不是详细写出文件细节。例如，在类名上面描述，当前类的作用，而不是实现细节。

3、在不同的代码逻辑间利用空格作为间隔，增加代码的可读性，例如在package与import声明之间，不同的函数方法之间的空格。

4、在各行代码间，应该用距离表示代码间的紧密关系，越近的代码，表示关系越紧密，让关系紧密的代码距离尽量近，可以增加代码的可读性。

5、让代码紧密的几个方法：

​ a、变量声明：变量的声明尽量在使用的位置，由于函数较短，变量的声明一般在函数方法顶部。在较长的函数中，变量的声明也可在代码块的上方。一般也不需要加上private，public等关键字。

​ b、实体变量：在java中，实体变量的声明应该在类的顶部

​ c、相关函数：若一个函数方法调用另一个，那么最好让被调用的函数在调用者的下方，如果调用多个，可以按照调用顺序依次排在调用者的下方。

​ d、概念相关：例如构造函数应该放在一起。

5.3 横向格式

1、一行字符最多120，一般最多80；

2、相关性较弱的事物用空格分开；例如

int k = 2;

再者，方法名与圆括号之间应该没有空格，参数和方法名间相关性，还是比较强的。

其次，不同的运算符的优先级之间可以有空格，让人更好区分。例如

return b*c - a/2;

3、有效的缩进：例如方法实现与方法声明之间等等。