代码审查(CodeReview),就是让别人来审查你的代码,其目的就是确保代码库的整体代码运行状况随着时间推移而不断改善。
中国有句古话:三人行必有我师。
代码审查同样如此:
他人的审查或许会有不一样的思考和建议;人都会犯错,多一个人检查就减少犯错的机率。因此代码审查是你编写的代码在合并到主分支前最重要的一项检查工作,也是一项最直接、最低成本的发现软件中的错误绝佳方式。
既然代码审查这么重要,而且有这样显而易见的收益,但总能听到代码审查在团队里执行起来不容易、效果不理想的问题。问题出在哪呢?
据我观察有两点原因:
第一,读别人代码需要花时间,往往还需要代码提交者带着业务为审查者讲一遍,同时占用双方时间;其次,如果代码审查者工作繁重、压力大而没有时间,也很容易造成执行不到位,走过场;
如何才能比较好的开展代码审查?让我们先来看看大公司是怎么做的,Google的这篇关于代码审查的文章里给出了具体法则。
Google的代码审查法则在进行代码审查时,应确保:
代码经过精心设计该功能对代码用户很有帮助任何UI更改都是明智的,并且看起来不错任何并行编程都是安全完成的代码没有比需要的复杂开发人员没有实现他们将来可能需要的东西代码具有适当的单元测试测试经过精心设计开发人员对所有内容使用了清晰的名称注释清晰实用,并且主要说明Why而不是What代码已正确文档化该代码符合我们的样式指南确保检查要求你检查的每一行代码,查看上下文,确保你在改善代码运行状况,并称赞开发人员所做的出色工作。
原文: