step

Code Review

代码审查清单 (Code Review)

以下内容属于摘录,出处不详。

常规项

  • 代码能够工作么?
  • 它有没有实现预期的功能,逻辑是否正确等。 所有的代码是否简单易懂?
  • 代码符合你所遵循的编程规范么?
  • 这通常包括大括号的位置,变量名和函数名,行的长度,缩进,格式 和注释。 是否存在多余的或是重复的代码?
  • 代码是否尽可能的模块化了?
  • 是否有可以被替换的全局变量?
  • 是否有被注释掉的代码?
  • 循环是否设置了长度和正确的终止条件?
  • 是否有可以被库函数替代的代码?
  • 是否有可以删除的日志或调试代码

安全

  • 所有的数据输入是否都进行了检查(检测正确的类型,长度,格式和范围)并且进行了编码?
  • 在哪里使用了第三方工具,返回的错误是否被捕获?
  • 输出的值是否进行了检查并且编码?
  • 无效的参数值是否能够处理?

文档

  • 是否有注释,并且描述了代码的意图?
  • 所有的函数都有注释吗?
  • 对非常规行为和边界情况处理是否有描述?
  • 第三方库的使用和函数是否有文档?
  • 数据结构和计量单位是否进行了解释?
  • 是否有未完成的代码?
  • 如果是的话,是不是应该移除,或者用合适的标记进行标记比如‘TODO’?

测试

  • 代码是否可以测试?比如,不要添加太多的或是隐藏的依赖关系,不能够初始化对象,测试框架可以使 用方法等。
  • 是否存在测试,它们是否可以被理解?比如,至少达到你满意的代码覆盖(code coverage)。
  • 单元测试是否真正的测试了代码是否可以完成预期的功能?
  • 是否检查了数组的“越界“错误?
  • 是否有可以被已经存在的API所替代的测试代码?

构建自己的代码审查清单

上面的提到的内容是大而全,但是不是属于自己,需要根据自己实际情况内化成自己的内容。

构建自己的代码审查清单步骤是,记录审查过程中发现的错误,根据错误来量身定制,也就是错题本。

9/15/2020

Tagged with 思考

Posted September 15, 2020


WIJE picweijiew . github