代码审查清单可消除更多的bug

本文是翻译,版权归原作者所有


原文地址(source):http://blog.fogcreek.com/increase-defect-detection-with-our-code-review-checklist-example/

在关于高效代码审查的博客中,我们推荐使用清单(checklist)。清单是代码审查中的伟大工具——他们确保审查在团队里持续高效。它们也是确保常见问题被识别、解决的方便途径。

软件工程协会的研究表明,程序员常犯的错误有15-20种。因此把这种错误增加到清单里,你就能确保在它们出现时指出来,帮助消除这种隐患

代码审查清单可消除更多的bug

为了让你开始建立清单,下面是经典的条目列表:

代码审查清单

总体

安全

文档

测试

你还可以为清单增加一些语言相关的问题。

该清单故意没有包含所有的问题,你并不想一个长长的清单,以致于没人去使用。只需覆盖常见问题即可。

优化你的清单

把该清单做为一个起点,你应该针对具体用例进行优化。有个不错的办法,那就是让你的团队在代码审核时,花一点时间提出所产生的问题。有了这些数据,你就能够甄别出团队的常见错误,然后就被改造成常见清单。要确保删除那些不会发生的条目(你或许希望保持较少地发生,还有诸如安全相关的重要条目)。

集思广益,及时更新

做为通用法则,清单上的条目应该是具体的,如果有可能,你可以就此做一份二元决策【注1】。这有助于避免判断上的矛盾,与团队分享清单,并得到他们对于内容的认同也是不错的主意。确保定期审查清单,检查每一项以确保仍然相关。

有了优秀的清单武装,你就可以增加代码审核中的瑕疵数量。这有助于你提升代码质量、避免不稳定的代码审核质量。

为了更多地了解Fog Creek上的代码审核,请观看下面的视频:http://fast.wistia.net/embed/iframe/vigy79tuhq

译文:代码审查清单可消除更多的bug 》| 腊八粥