程序员|高效代码审查的十个经验

版权声明：本文为北京尚学堂原创文章，未经容许不得转载。

代码审查（Code Review)是软件开发中经常使用的手段，和QA测试相比，它更容易发现和架构以及时序相关等较难发现的问题，还能够帮助团队成员提升编程技能，统一编程风格等。

1. 代码审查要求团队有良好的文化

团队须要认识到代码审查是为了提升整个团队的能力，而不是针对个体设置的检查“关卡”。

“A的代码有个bug被B发现，因此A能力不行，B能力更好”，这一类的陷阱很容易被扩散从而影响团队内部的协做，所以须要避免。

另外，代码审查自己能够提升开发者的能力，让其从自身犯过的错误中学习，从他人的思路中学习。若是开发者对这个流程有抵触或者反感，这个目的就达不到。

2. 谨慎的使用审查中问题的发现率做为考评标准

高效代码审查的十个经验

在代码审查中若是发现问题，对于问题的发现者来讲这是好事，应该予以鼓励。但对于被发现者，咱们不主张使用这个方式予以惩罚。软件开发中bug在所不免，过分苛求自己有悖常理。更糟的是，若是形成参与者怕承担责任，不肯意在审查中指出问题，代码审查就没有任何的价值和意义。

3. 控制每次审查的代码数量

 

根据smartbear在思科所做的调查，每次审查200行-400行的代码效果最好。每次试图审查的代码过多，发现问题的能力就会降低，具体的比例关系以下图所示：

高效代码审查的十个经验

咱们在实践中发现，随着开发平台和开发语言的不一样，最优的代码审查量有所不一样。可是限制每次审查的数量确实很是必要，由于这个过程是高强度的脑力密集型活动。时间一长，代码在审查者眼里只是字母，无任何逻辑联系，天然不会有太多的产出。

4. 带着问题去进行审查

咱们在每次代码审查中，要求审查者利用自身的经验先思考可能会碰到的问题，而后经过审查工做验证这些问题是否已经解决。一个窍门是，从用户可见的功能出发，假设一个比较复杂的使用场景，在代码阅读中验证这个使用场景是否可以正确工做。

使用这个技巧，可让审查者有代入感，真正的沉浸入代码中，提升效率。你们都知道看武侠小说不容易瞌睡，而看专业书容易瞌睡，缘由就是武侠小说更容易产生代入感。

有的研究建议每次树立目标，控制单位时间内审核的代码数量。这个方法在咱们的实践中显得很机械和流程化，不如上面的方法效果好。

5. 全部的问题和修改，必须由原做者进行确认

若是在审查中发现问题，务必由原做者进行确认。

这样作有两个目的：

(1)确认问题确实存在，保证问题被解决

(2)让原做者了解问题和不足，帮助其成长

有些时候为了追求效率，有经验的审查者更倾向于直接修改代码乃至重构全部代码，但这样不利于提升团队效率，而且会增长由于重构引入新bug的概率，一般状况下咱们不予鼓励。

6.利用代码审查激活个体“能动性"

即便项目进度比较紧张，没法彻底的进行代码审查，至少也要进行部分代码的审查，此时随即抽取一些关键部分是个不错的办法。

背后的逻辑是，软件开发是很是有创造性的工做，开发者都有强烈的自我驱动性和自我实现的要求。让开发者知道他写的任何代码均可能被其余人阅读和审察，能够促使开发者集中注意力，尤为是避免将质量糟糕，乃至有低级错误的代码提交给同伴审查。开源软件也很好的利用了这种心态来提升代码质量。

7.在非正式，轻松的环境下进行代码审查

 

如前所述，代码审查是一个脑力密集型的工做。参与者须要在比较轻松的环境下进行该工做。所以，咱们认为像某些实践中建议的那样，以会议的形式进行代码审查效果并很差，不只由于长时间的会议容易让效率低下，更由于会议上可能出现的争议和思考不利于进行如此复杂的工做。

8.提交代码前自我审查，添加对代码的说明

全部团队成员在提交代码给其余成员审查前，必须先进行一次审查。此次自我修正形式的审查除了检查代码的正确性之外，还能够完成以下的工做：

(1)对代码添加注释，说明本次修改背后的缘由，方便其余人进行审查。

(2)修正编码风格，尤为是一些关键数据结构和方法的命名，提升代码的可读性。

(3)从全局审视设计，是否完整的考虑了全部情景。在实现以前作的设计若是存在考虑不周的状况，这个阶段能够很好的进行补救。

咱们在实践中发现，即便只有原做者进行代码审查，仍然能够很好的提升代码质量。提示：更多精彩内容关注微信公众号：北京尚学堂科技有限公司。

9.实现中记录笔记能够很好的提升问题发现率

成员在编码的时候应作随手记录，包括在代码中用注释的方式表示，或者记录简单的我的文档，这样作有几个好处：

(1)避免遗漏。在编码时将考虑到的任何问题都记录下来，在审查阶段再次检查这些问题都确认解决。

(2)根据研究，每一个人都习惯犯一些重复性的错误。这类问题在编码是记录下来，能够在审查的时候用做检查的依据。

(3)在反复记录笔记并在审查中发现相似的问题后，该类问题出现率会显著降低

10. 使用好的工具进行轻量级的代码审查

“工欲善其事，必先利其器”。咱们使用的是bitbucket提供的代码托管服务。

每一个团队成员独立开发功能，而后利用Pull Request的形式将代码提交给审查者。复审者能够很方便在网页上阅读代码，添加评论等，而后原做者会自动收到邮件提醒，对审阅的意见进行讨论。提示：更多精彩内容关注微信公众号：北京尚学堂科技有限公司。

即便团队成员分布在天南海北，利用bitbucket提供的工具也能很好的进行代码审查。​​

提示：更多精彩内容关注微信公众号：北京尚学堂科技有限公司

更多猛料！欢迎扫描上方二维码关注北京尚学堂官方微信公众号 （ 资料领取验证消息：156）