背景很多公司都要求项目做CodeReview,但很多项目第一次组织CodeReview往往不知道该如何做,也不知道为什么去做,参加过几个项目组的CodeReview,发现一些共性问题:
-
有时候参与Review的人太多了,意见太分散,Review时间拉的很长,发现问题效率低;
-
有时候会发现一个CodeReview时间很长,参与者会觉得煎熬和浪费时间;
-
有时候不太了解对方评审的东西,没法跟上大家的思路,影响效率;
-
有时候走查的代码量太大了,无法做到详细走查;
-
有时候会看到有些人无所事事、精神不集中、不发言,影响效果。
对这些问题,用鱼骨图做个分析:
写这篇文章,希望本文中的一些建议能够缓解上述问题,能使新人更快的了解CodeReview的意义和方法,有经验的人能够更加快速有效的进行CodeReview。
CodeReview的目标和原则
CodeReview的目的是提升代码质量,尽早发现潜在缺陷与BUG,降低修复成本,同时促进团队内部知识共享,帮助更多人更好地理解系统。建议CodeReview的原则如下:
-
发现代码的正确性
代码审查用意是在代码提交前找到其中的问题——你要发现的是它的正确性。在代码审查中最常犯的错误—几乎每个新手都会犯的错误是,审查者根据自己的编程习惯来评判别人的代码。
-
不仅是在Review Code,更是在分享和学习
Code Review最重要的是讲解者分享业务流程和设计思路,参与者通过这些讲解获得这些信息,使得更多人理解这个系统,提升团队整体水平,使得团队维护代码的能力提升。
-
高效迅