代码审查(Code Review)

什么是代码审查

  代码审查(code review)是一种可以有效帮助提升代码质量的途径,它是对源代码进行系统化的审查,可以找出及修正软件开发初期未发现的错误及可以对代码进行优化指导,目的在于提升代码质量及开发者技术水平。

代码审查的好处

  1. 帮助提高代码质量,修正代码错误,让软件产品的问题更少更容易维护。

    2. 有助于熟悉项目中各个模块,我们系统大都是由多人开发,平常每个人都负责自己那一块,对于其他人写的了解并不够,代码审查时候会联系代码修改模块的上下文及相应的业务,这样让不了解这块内容的团队成员了解了这块内容。

      3. 帮助新人融入团队,因为一个新人加入团队对团队的技术规范及业务需求不是很熟悉,在代码审查的时候会对实际和具体的代码和需求进行阅读及分析,可以帮助新人了解业务,也会设计到代码层面的技术讨论,让新人有了直观的了解。

    4. 可以帮助团队成员成长,在代码审查的时候会找出一些不合理的及可以优化的地方,团队成员可以在相互的讨论中了解解决问题及思考问题方式方法,补充和完善对自身对问题的思考。以后再遇到相似的问题可以有更合适的方案。

代码审查的代价

  需要额外的时间和精力。当然可以选择一个合适的时间或者自己进行代码审查。

代码审查时机

  代码审查需要及时进行的,比如当一个项目快结束的时候就可以进行代码审查。不能当项目上线了或者代码的作者进入别的项目在进行代码审查就晚了。

      1. 当有代码变更被提交到远程仓库了就可以进行代码审查。

      2. 代码通过git提交,开发git分支被合到测试分支或者master分支时候,也就是merge request(MR)可以由合并分支的负责人负责代码审查。

代码审查频率

    1. 集中式:团队所有成员面对面在一起,比如在一个会议室,通过会议共享屏幕翻阅仓库代码并讨论,这种方式沟通效率高,但是需要协调团队所有成员时间。这种最好频率不要太高。

      2. 异步式:这种可以借助工具来随时进行代码审查。相对集中式不需要协调所有人的时间,自己可以进行代码审查,但是沟通没有集中式高效。

代码审查常见工具

原文地址:https://www.cnblogs.com/songgj/p/9337232.html