导语：代码整洁之道-格式

无规矩不成方圆，无论工作、生活，还是编程。个人或团队应该采用一套简单的格式规则，且只能有一套规则，贯彻、遵从它，保持良好的代码格式，减少沟通成本。使用相应的自动化工具也是会有帮助的。

1、格式的目的

代码格式很重要，必须严肃对待，关乎沟通，而沟通是专业开发者的头等大事。

2、垂直格式

项目中尺寸各不相同，长度殊异。大多数为200行、最长500行的单个文件构造出色的系统，尽管这并非是不可违背的原则，也应该乐于接受，短文件通常比长文件易于理解。

2.1 向报纸学习

写法应该向报纸文章学习，名称应当简单一目了然。

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

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

2.2 概念间垂直方向上的区隔

每组代码行展示一条完整的思路，思路间用空白行区隔开来。

人生需要适当留白，代码亦如此

2.3 垂直方向上的靠近

紧密相关的代码应该相互靠近。

2.4 垂直距离

除非有很好的理由，否则就不要把关系密切的概念放到不同的文件中。实际上，这也是避免使用protected变量的理由之一。

变量声明应尽可能靠近其使用位置，因为函数很短，本地变量应该在函数顶部出现。

循环中的控制变量应该总是在循环语句中声明。

实体变量应该在类的顶部声明。

相关函数，若某个函数调用了另外一个，就应该把他们放在一起，而且调用者应该尽可能放在被调用者上面。

概念相关。概念相关的代码应该放到一起。相关性越强，彼此之间的距离就该越短。

2.5 垂直顺序

一般而言，我们想自上向下展示函数调用依赖顺序。也就是说，被调用的函数就应该放在执行调用的函数下面。

3、横向格式

应尽量保持代码行短小。可以尝试遵从无需拖动滚动条到右边的原则，建议上限是120个字符。

3.1 水平方向上的区隔与靠近

赋值语句有2个确定而重要的要素：左边和右边。空格字符加强了分隔效果。

合理使用空格展示效果。参数之间用空格隔开，表示参数是相互分离的，乘法之间的因子不加空格，因为它的优先级较高，加减之间加空格，它们的优先级较低。

3.2 水平对齐

不强行使用水平对齐，如果有较长的列表需要做对齐处理，那问题就是在列表的长度上而不是对齐上。

3.3 缩进

源文件是一种继承结构，缩进使其层级性明显，可阅读性提高了，不要违反缩进规则。

3.4 空范围

应该保持空范围体的缩进，否则难以阅读。

4、团队规则

团队成员都应该遵从这一原则，并且是统一的代码风格。

综上，结合两个手表的原理，如果一个人有2个手表，当2个手表时间不一致的时候，人就不知道到底看哪一时间，哪一个时间是准确的，所以团队需要有且只能有一套规则，并要执行它，去写，执行吧。

免责声明:本站部份内容由优秀作者和原创用户编辑投稿，本站仅提供存储服务，不拥有所有权,不承担法律责任。若涉嫌侵权/违法的，请反馈，一经查实立刻删除内容。本文内容由快快网络小萱创作整理编辑！