SmartbBear给出的11条代码审查最佳实践

Contents

代码审查（Code Review）的作用毋庸置疑，但是如何高效地做好代码审查，是一个需要不断尝试，不断提高的过程。我之前的一篇博客 用code workshop取代code review提到过Box公司是怎么用workshop的形式来做code review的，今天再分享一个SmartBear通过在思科10个月的代码审查总结出来的一个代码审查的建议11 Best Practices of Peer Code Review。

1. 每次审查200-400行代码。
2. 代码审查的速度控制在每小时300-500行以下。
3. 分配足够的时间来慢慢的做代码审查，但是不要超过60-90分钟。
4. 代码的作者需要在审查之前对代码做一些解释。这个除了可以帮助审查者更快的理解代码之外，一般人在第二次看自己的代码时，并且给别人讲解时可以发现自己在第一次写代码时考虑不周之处。
5. 记录每次代码审查的结果，并建议一个可以量化的目标，从而可以不断改进。
6. 代码审查的Check List非常重要。
7. 保证代码审查发现的问题之后被修复了。
8. 老板要营造一个好的代码审查的氛围，鼓励找到问题。
9. 考虑“老大在看着你”效应。老板必须持续的表明找到问题是好事，在代码中找到问题和个人能力之间没有必然联系。
10. 个人荣誉。知道自己的代码会被审查，每个人都会在写代码时三思而后写。
11. 轻量级的代码审查通常更有效。