CodeReview(CR):代码评审。研发团队在代码开发过程中对源代码的系统性检查,用以查找系统缺陷,保证软件总体质量和提高开发者自身水平。
CR是轻量级代码评审,相对于正式代码评审,轻量级代码评审所需要的各种成本更低。
代码级别:1. 可编译;2. 可运行;3. 可测试;4. 可读;5. 可维护;6. 可重用。自动化测试的代码只能达到第3级,通过CR的代码可以在第4级甚至更高。
如何进行CR?
成员:由编码者自行邀请成员与自己一起进行。
时间:开发过程中的清晰功能节点代码提交时进行。
方式:
- 插件完成。在人工CR之前,先借助插件扫描并修改完成,主要检查代码规范性问题,如代码缩进,变量定义等。插件工具如Alibaba Java Coding Guidelines(Java)
- 人工CR。注重编程素养、业务逻辑、架构设计、单元测试、性能、安全。
常见检查问题:
- 代码能够工作吗?他有没有实现预期的功能,逻辑是否正确?
- 所有的代码是否简单易懂?
- 代码符合编程规范吗?如大括号的位置、变量名和函数名、行的长度、缩进、格式和注释。
- 是否存在多余的或者重复的代码?
- 代码是否尽可能的模块化了?
- 是否有可以被替换的全局变量?
- 是否有被注释掉的代码?
- 循环是否设置了长度和正确的终止条件?
- 是否有可以被库函数替代的代码?
- 是否有可以删除的日志或调试代码?
- 所有的数据输入是否都进行了检查(检查正确的类型、长度、格式和范围)并进行了编码?
- 在哪里使用了第三方工具,所返回的错误是否被捕获?
- 输出的值是否进行了检查并且编码?
- 无效的参数值是否能够处理?
- 是否有注释?并且描述了代码的意图?
- 所有的函数都有注释吗?
- 对非常规行为和边界情况处理是否有描述?
- 第三方库的使用和函数是否有文档?
- 数据结构和计量单位是否进行了解释?
- 是否有未完成的代码?如果是的话,是不是应该移除,或者用合适的标记进行标记。
- 代码是否可以测试?
- 是否存在测试?
- 单元测试是否真正的测试了代码是否可以完成预期的功能?
- 是否检查了数组的越界行为?
- 是否有可以被已经存在的API所替代的测试代码?