为什么要做代码 Review
为什么要代码 Review，相信每个人心中都有比较一致的答案，Google 搜索一下也能找到一大堆的文章。这里简单总结几点：
1.提高代码质量
代码review可以发现代码中的问题,如逻辑错误、不符合规范的地方、可重构的代码等。及时发现并改进这些问题,可以提高代码的整体质量和可维护性。
2.分享知识和经验
代码review可以让不同开发者分享彼此的知识和经验。 reviewer可以将自己的知识点传递给 reviewee,使对方在以后开发中更加准确高效。反之, reviewer也可以从中学习到新知识。
3.减少bug
代码review可以在早期发现代码中的隐藏bug或逻辑漏洞,并进行修复。这比单元测试或运维发现bug的成本要小得多,有利于项目的进度控制和成本节省。
4.统一编码规范
代码review可以帮助开发团队统一编码规范和项目风格。reviewer可以检查代码是否符合规范,并要求进行修改,这有助于项目的可读性和可维护性。
5.培养新人
对新人开发者的代码进行review,可以帮助其熟悉项目规范,掌握开发技巧,提高编程思维能力。新人可以在早期学习到很多宝贵的知识和经验,从而更快融入团队,成长为一名高效的开发者。
6.构建团队精神
代码review可以增强团队之间的互动和理解,从而增强团队精神。开发者在彼此的代码中发现对方的优秀之处,这会让他们产生互相学习和钦佩的情感,有利于团队的凝聚力。
如何进行有效地代码review
1.重点关注代码的结构和质量
代码review的重点应该是代码的结构、设计和质量,而不是代码中的细节问题。我们应该检查代码是否易读、易维护、符合设计模式等,而不是纠结于某个变量名或格式是否完全正确。
2.提出建设性意见
我们应该提出建设性的修改意见,而不是主观臆断的否定意见。意见需要有理有据,并且提供改进方案或示例。此外,我们还需要考虑到开发者的实际情况,意见不能脱离现实。
3.分清主次要点
在给出意见时,我们要清楚主次要点。主要意见直接影响代码质量和开发进度,而次要意见可以稍后提出或在之后版本中迭代。我们不应该把所有的小细节均视为主要意见强制要求改进。
4.提供全面意见
我们不应该只关注某一方面,应该从代码整体的角度来审阅和提出意见。包括代码结构、命名、格式、逻辑、注释等多方面,这样可以真正提高代码质量。如果仅关注某一方面,很容易忽略其它更重要的问题。
5.关注意见的重复与一致性
在一个 review 中,我们不应该提出相互矛盾的意见,这会误导开发者。同时,我们也需要避免提出重复的意见,这会增加开发者的负担。我们应该梳理清楚需要改进的点,尽量用简洁和精炼的语言表达。
6.提出客观中立的意见
我们不应该在意见中透露个人偏见,意见应该基于代码本身和业界最佳实践。无论个人与代码作者是否存在矛盾,我们都应该像医生一样秉持“PERIM 不满足则改之”的态度,客观中立地提出专业意见。
7.follow up 重要意见的改进
对于关键的 review 意见,我们需要跟进开发者的改进结果。如果改进未达要求或产生新问题,我们还需要再次提出意见,直到问题完全解决。这可以确保 review 意见的落实,达到预期的效果。
综上,有效的代码review需要审视代码整体,提出客观建设性的意见,并根据优先级和影响率区分主次要点。同时,我们还需要跟进重要意见的改进结果,确保问题得到解决。只有这样,代码review才能真正发挥其作用,提高代码质量和开发效率。
