Code Review

一、什么是 Code Review?

顾名思义，Code Review就是代码再次查看评审。那么一个成熟的开发团队为什么要做 Code Review?对于经验不足或者刚开始一份新工作的人来说，通过 Code Review 可以得到更资深的人帮助，更快熟悉现有的规范和架构，在新的环境和团队中快速提升。对于资深的工程师来说，让其他同事 review 代码，有利于在团队中传播经验、知识和好的实践。

二、我们团队期望实施 Code Review后可以达到的效果

1、短期内迅速提高代码质量
大家能在 Review 的过程中学习到其他同事优秀的编码方式和习惯。
2、团队成员对项目的熟悉程度会比较均衡。
同事通过参与Code Review能很快熟悉团队的规范。
3、改善团队的氛围
Review的过程中会需要非常多的沟通，多沟通能拉近团队成员的距离。

三、Code Review 主要检查的点
本次以图像测试平台为例：

1、完整性检查
代码是否完全实现了由管理员创建项目、到标注员领包、标注、打分的完整流程。
代码是否已创建了需要的数据库，包括正确的初始化数据
代码中是否存在任何没有定义或没有引用到的变量、常数或数据类型
2、一致性检查
代码的逻辑是否符合设计文档
代码中使用的格式、符号、结构等风格是否保持一致
3、正确性检查
所有的变量都被正确定义和使用
所有的注释都是准确的
所有的程序调用都使用了正确的参数个数
4、可修改性检查
代码涉及到的常量是否易于修改(如项目配置、项目类型、项目的分类及难度调整)
5、可重用性
原则：同一代码不应该重复两次以上，考虑可重用的服务，功能和组件，考虑通用函数和类
6、可扩展性
本次上线的矩形标注平台，下次增加多边形标注功能需要变动哪些模块？是否留有扩展功能

四、Code Review 的步骤

1、周四早晨 10 点，由赵骐和焦世豪讲解自己负责的图像测试平台的代码和相关逻辑；
2、参与者在此过程中可以随时提出自己的疑问，同时积极发现隐藏的bug；由赵骐对这些bug记录在案。
3、赵骐和焦世豪根据大家给出的修改意见，记录下问题及修改意见，有不清楚的地方可积极向意见提出者提出。
4、赵骐把Code Review中发现的有价值的问题更新到"代码审核规范"的文档中。

五、备注

要经常性的进行 Code Review，因为程序员代码写得时候越长，程序员就会在代码中加入越来越多的个人的东西。
人数不要多，3-5 人小型会议最佳。
Code Review 不要太正式，Code Review不是批斗大会，轻松的氛围能激发大家的积极性。