专业开发者必备技能:代码格式整洁最重要
扫描二维码
随时随地手机看文章
1、代码格式不可忽略,必须严肃对待。代码格式关乎沟通,而沟通是专业开发者的头等大事。
2、在java中,文件尺寸与类尺寸极其相关。
3、源文件名称本身应该足够告诉我们是否在正确的模块中。源文件最顶部应该给出高层概念和算法。细节应该往下渐次展开,直至找到源文件中最底层的函数和细节。
4、几乎所有的代码都是从上往下读,从左往右读。每行展现一个表达式或一个子句,每组代码行展示一条完整的思路。这些思路用空白行区隔开来。
5、如果说空白行隔开了概念,靠近的代码行则暗示了它们之间的紧密关系。所以,紧密相关的代码应该互相靠近。
6、关系密切的概念应该相互靠近。显然,这条规则并不适用于分布在不同文件中的概念。除非有很好的理由,否则就不要把关系密切的概念放在不同的文件中。实际上,这也是避免使用protected变量的理由之一。
7、对于那些关系密切、放置同一源文件的概念,它们之间的区隔应该成为对相互的易懂度有多重要的衡量标准。应避免迫使读者在源文件和类中跳来跳去。
8、变量声明应尽可能靠近其使用位置。因为函数很短,本地变量应该在函数的顶部出现。循环中的控制变量应该总是在循环语句中声明。偶尔,在较长的函数中,变量也可能在某个代码块顶部,或在循环之前声明。
9、实体变量应该在类的顶部声明。这应该不会增加变量的垂直距离,因为在设计良好的类中,它们如果不是被类的所有方法也是在被大多数方法所用。
10、若某个函数调用了另外一个,就应该把它们放到一起,而且调用者应该尽可能放在被调用者上面。这样,程序就有个自然的顺序。若坚定地遵循这条约定,读者将能够确信函数声明总会在其调用后很快出现。
11、概念相关的代码应该放到一起。相关性越强,彼此之间的角力就该越短。相关性应建立在直接依赖的基础上,如函数间调用,或函数使用某个变量。但也有其他相关性的可能。相关性可能来自于执行相似操作的一组函数。 12、一般而言,我们想自上而下展示调用依赖顺序。也就是说,被调用的函数应该放在执行调用的函数下面。这样就建立了一种自顶向下贯穿源代码模块的良好信息流。
13、一行代码应该有多宽?程序员更喜爱短行代码。所以,应尽力保持代码行短小。死守80个字符的上限有点僵化,而且我也并不反对代码行长度达到100个字符或120个字符。再多的话,大抵就肆意妄为了。
14、我们使用空格字符将彼此紧密相关的事物连接到一起,也用空隔把关系性弱的事物分隔开。赋值语句有两个确定而重要的要素:左边和右边。空格字符加强了分隔效果。另一方面,不在函数名和左圆括号之间加空格。这是因为函数与其参与密切相关,如果分隔开,就会显得互无关系。把函数调用括号中的参数一 一 隔开,强调逗号,表示参数是互相分离的。
15、乘法因子之间不加空格,因为它们具有较高优先级。加减法运算项之间用空格隔开,因为加法和减法优先级较低。但是多数代码格式化工具都会漠视运算符优先级,从头到尾采用同样的空格方式。
16、水平对齐,像是在强调不重要的东西,把程序员的目光从真正意义上拉开。建议用不对齐的声明和赋值。如果有较长的列表需要做对齐处理,那问题就是在列表的长度上而不是对齐上。
17、源文件是一种继承结构,而不是一种大纲结构。其中的信息涉及整个文件、文件中每个类、类中的方法、方法中的代码块,也涉及代码块中的代码块。这种继承结构中的每一层级都圈出一个范围,名称可以在其中声明,而声明和执行语句也可以在其中解释。要让这种范围式继承结构可见,我们依源代码在继承结构中的位置对源代码行做缩进处理。在文件顶层的语句,例如大多数的类声明,根本不缩进。类中的方法相对该缩进进一个层级。方法的实现相对声明缩进一个层级。代码块的实现相对于其容器代码缩进块缩进一个层级,以此类推。
18、程序员相对依赖这种缩进模式。他们从代码左边查看自己在什么范围中工作。这让他们能快速跳过与当前关注的情形无关的范围,例如if或while语句的实现之类。他们的眼光扫过左边,查找新的方法声明、新变量,甚至新类。没有缩进的话,程序就会变得无法阅读。
19、有时,while或for语句的语句体为空,如果无法避免,就确保空范围体的缩进,用括号包围起来。
20、每个程序员都有自己喜欢的格式规则,但如果在一个团队中工作,就是团队说了算。一组开发者应当认同一种格式风格,每个成员都应该采用那种风格。