豪翔天下

Change My World by Program

0%

代码审查清单

代码审查清单

自己的代码审查清单,可以根据此来写测试

code方面

  • 代码能否正常工作,各个功能是否能得到正确的结果
  • 代码是否符合当前语言的编码规范,Python使用PEP8
  • 是否存在多余的代码和注释
  • 代码是否尽可能模块化了
  • 循环是否设置了终止条件
  • 是否有可删除的日志或调试代码

安全

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

文档

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

测试

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

坚持原创技术分享,谢谢支持

欢迎关注我的其它发布渠道