code review清单
常规项:
- 能否正常工作,是否实现了预期功能,逻辑是否正确
- 是否简单易懂
- 是否符合编程规范
- 是否存在多余的或重复的代码
- 是否尽可能模块化了
- 是否有可以被替换的全局变量
- 是否有被注释掉的代码
- 循环是否设置了长度和正确的终止条件
- 是否有可以被库函数替代的代码
- 是否有可以删除的日志或调试代码
安全:
- 所有的数据输入是否都进行了检查
- 无效的参数值能否被处理
- 输出的值是否进行了检查并且编码
- 在哪里使用了第三方工具,返回的错误是否被捕获
文档
- 是否有注释、并且描述了代码意图
- 对非常规行为和边界情况处理是否有描述
- 数据结构和计量单位是否进行了解释
- 是否有未完成的代码,如果有是否要移除或者标记为todo
- 第三方库的时候和函数是否有文档
网友评论