团队最佳实践和 GuideLine 系列 (二)：代码规范的意义

有不少写代码总是只按喜欢按自己的习惯写，但是如果这个产品永远是你自己一个人来写和维护，那么问题不大，那么如果是有很多人协作，那么麻烦就大了，我相信有很多人说了很多代码规范的重要性，我今天在这里只提两点意义。

可读性

代码规范最大的目的就是保持可读性。

Martin Fowler 说:

Any fool can write code that a computer can understand. 随便找个笨蛋都能写出电脑可以明白的代码

Good programmers write code that humans can understand. 好的程序员写的代码是让人能看明白的

其实，明白了可读性重要后，是有一些方法来提高可读性的。

1. 自己每写完一段代码，至少读三遍，看看是否能够明白，知道为什么要这么写和自己是怎么写的。
2. 代码写完了，可以让别人看你的代码，就看那一个方法，不要太多上下文，如果别人能够明白，就是很不错的。如果不明白，可能是命名不对，或者if,else太多大家被绕进去了。
3. 好的代码光看类名就知道类是做什么的，光看方法名就知道这一个方法解决哪一个具体问题（单一职责）
4. 写单元测试，如果代码测试覆盖率好，可读性也更好，前提是单元测试要写好。
5. 可读性好的代码，任何人也都可以帮忙写单元测试。

可维护行

代码规范的另一个主要目的就是可维护性。

可维护性就是：how easily a system can be modified

这个可维护性一定还是基于代码的可读性上，在可维护性方面有几个实践记得参考。

1. 写代码的时候一定要觉得我做的产品将来我会维护，当然肯定不全是，但是做的时候要这么思考
2. 保持一个廉耻心，心里想着如果代码不是我维护，将来千万不要改代码的时候让别人问候我的家人
3. 使用大家熟悉的技术或者通用的技术。
4. 使用大家常用的一些结构比如MVC, MVVM等等。
5. 使用一些好的实践比如单元测试 （修改代码的时候就不怕破坏隐藏的功能）
6. 留下必要的文档。
7. 项目相关的东西集中在一起。