代码整洁之代码格式准则！

像报纸一样一目了然

想想那些阅读量巨大的报纸文章

• 你从上到下阅读

在顶部，你希望有个头条，告诉你故事主题，好让你决定是否要读下去

• 第一段是整个故事的大纲，给出粗线条概述，但隐藏了故事细节

接着读下去，细节渐次增加，直至你了解所有的日期、名字、引语、说话及其他细节

优秀的源文件也要像报纸文章一样。名称应当简单并且一目了然，名称本身应该足够告诉我们是否在正确的模块中

• 源文件最顶部应该给出高层次概念和算法

细节应该往下渐次展开，直至找到源文件中最底层的函数和细节

恰如其分的注释

带有少量注释的整洁而有力的代码，比带有大量注释的零碎而复杂的代码更加优秀

• 我们知道，注释是为代码服务的，注释的存在大多数原因是为了代码更加易读，但注释并不能美化糟糕的代码

另外，注意一点。

• 注释存在的时间越久，就会离其所描述的代码的意义越远，越来越变得全然错误
  • 因为大多数程序员们不能坚持（或者因为忘了）去维护注释

当然，教学性质的代码，多半是注释越详细越好

合适的单文件行数

尽可能用几百行以内的单文件来构造出出色的系统，因为短文件通常比长文件更易于理解

• 当然，和之前的一些准则一样，只是提供大方向，并非不可违背

例如，《代码整洁之道》第五章中提到的FitNess系统

• 就是由大多数为200行、最长500行的单个文件来构造出总长约5万行的出色系统

合理地利用空白行

古诗中有留白，代码的书写中也要有适当的留白，也就是空白行

• 在每个命名空间、类、函数之间，都需用空白行隔开（应该大家在学编程之初，就早有遵守）

这条极其简单的规则极大地影响到了代码的视觉外观

• 每个空白行都是一条线索，标识出新的独立概念

其实，在往下读代码时，你会发现你的目光总停留于空白行之后的那一行

• 用空白行隔开每个命名空间、类、函数，代码的可读性会大大提升

让紧密相关的代码相互靠近

如果说空白行隔开了概念，那么靠近的代码行则暗示了他们之间的紧密联系

• 所以，紧密相关的代码应该相互靠近。

基于关联的代码分布

关系密切的概念应该相互靠近

对于那些关系密切、放置于同一源文件中的概念，他们之间的区隔应该成为对相互的易懂度有多重要的衡量标准

应该避免迫使读者在源文件和类中跳来跳去

• 变量的声明应尽可能靠近其使用位置

对于大多数短函数，函数中的本地变量应当在函数的顶部出现

团队规则

每个程序员都有自己喜欢的格式规则，但如果在一个团队中工作，就是团队说了算

• 一组开发者应该认同一中代码风格，每个成员应该遵守这个规则

• 一个好的团队应当约定与遵从一套代码规范，并且每个成员都应当采用此风格

我们希望一个项目中的代码拥有相似甚至相同的风格，像默契无间的团队所完成的艺术品

• 而不是像一大票意见相左的个人所堆砌起来的残次品

定制一套编码与格式风格不需要太多时间，但对整个团队代码风格统一性的提升，却是立竿见影的

记住，好的软件系统是由一系列风格一致的代码文件组成的

• 尽量不要用各种不同的风格来构成一个项目的各个部分，这样会增加项目本身的复杂度与混乱程度