Code Review

• 什么是code review？

Code review是指在软件开发过程中对源代码的系统性检测。目的是查找系统缺陷，保证软件总体质量和提高开发者自身水平。

• 为什么执行code review

①代码评审可以及时发现一些容易发现的BUG，而不必将发现BUG的时间点推迟到测试阶段，提高整体项目代码运行速率。

②码评审可以保证至少有两个人都理解任何一份代码。当出现员工休假，离职等情况的时候，至少保证团队的代 码不会陷入无人理解或者无人处理的状况。

③代码评审的最大好处是纯社会性的，当你知道你的每一行代码都有另外一个人看，自然而然会更加卖力的表现，拿出最好的状态编码，提高代码的质量。

• Code review的原则

①明确coding的规则，通常包括变量名、函数名、行的长度、缩进、格式和注释等。

②尽量保证代码是否简单易懂，是否有多余或重复的代码。

③尽可能的对代码进行模块化。

• Code review的流程

1、提交评审前

①程序员在试图提交代码变更到代码库之前，先提交变更申请，变更申请包含了这次变更的内容，评审人；

②评审人查看变更内容，评估变更，与变更申请人沟通，评估是否通过变更；

③如果评审人通过变更，则变更申请人才可以提交代码到代码库；

④如果评审人不通过变更，则变更申请人需要根据讨论结果或评审建议做出修改，直到与评审人达成一致，通 过评审，才可以提交代码到代码库；

2、提交后评审

①程序员提交变更代码到代码库；

②评审人审查这次变更的内容，如果评审通过，则标记此次的变更已审查；

③如果评审人有疑义，则与变更人沟通，变更人根据讨论结果或评审意见做出修改，知道与评审人达成一致，通过评审。

3、提交前评审对比提交后评审有诸多好处

①程序员会更积极的将变更的代码组织的更好，更模块化，更容易阅读；

②评审人有机会在代码提交之前发现问题，或给出更好的建议，对应的程序员对这样的反馈更容易接受；

③评审人给出建议或意见之后，相比提交后评审，程序员会更加积极的最反馈做出响应；

④评审人会更加认真的对变更进行评审，并且发现问题后会更加积极的参与讨论，对发起变更的程序员提供支 持；

⑤在真正提交变更前发现问题并予以解决显然比提交后再进行评审，然后提交修改补丁更好。

4、提交后评审对比提交前评审有诸多好处

①提交后评审更加容易实施，过程对现有的组织架构和流程没有完全的颠覆，对团队成员的要求没 有那么高；

②相比提交前评审，提交后评审不需要对修改代码&提交变更这个过程中断，不需要等待 评审的时间；

③可以作为组织向提交前评审过程实施的过渡训练。