如何做Code Review(代码审查)

时间:2024-03-25 20:26:05

一、什么是Code Review?

Code Review即代码审查,是指在软件开发过程中,对代码进行系统性审查,用于检查代码是否符合规范、是否存在缺陷及潜在问题、提升可读性、可维护性和可扩展性,保障软件总体质量和提高开发人员自身水平。

二、Code Review的好处

  1. 提前发现代码中存在的缺陷与潜在问题,降低线上故障率
  2. 提升代码质量
  3. 增强团队成员之间沟通,提升专业技能

三、为什么要做Code Review?

  1. 团队成员经常变动,新老交替,对业务及规范、常见问题了解不尽相同.
    如何做Code Review(代码审查)
  2. 每个人总会犯错,多个人把关,可以适度降低出错概率. 人非圣贤,孰能无过.
    如何做Code Review(代码审查)

四、如何做Code Review?

  1. 小范围Code Review(如1对1)
  • 具体开展形式: 由被Review的人,先讲解需求,对照讲解代码如何实现.Review的人再针对性提出意见.
  • 优点: 评审比较深入,斗争比较激烈.
  • 缺点: 评审参与人员不能太多,提出意见数量及范围有限.
    如何做Code Review(代码审查)
  1. 大范围Code Review(如开会)
  • 具体开展形式:
    由被Review的人,先以邮件等形式发出需求,并文档形式介绍涉及的主要代码,大致实现方式.
    Review的人提前查看需求及代码,并准备问题.
    会议中,被Review的人大致介绍需求及代码,重点评审大家提前提出的问题及现场提出的问题.
  • 优点: 评审人员较多,看到的问题较为全面
  • 缺点: 花费的人力和时间都非常客观,偶尔搞搞可以,经常搞,估计不行.
    如何做Code Review(代码审查)

五、Code Review闭环

对于Code Review,需要对问题进行记录,事后跟踪闭环,并形成经验总结,避免后续出现同样的问题. 对于累教不改者,只能一个字:
如何做Code Review(代码审查)