关于Python Code Review的建议

January 08, 2016

截图摘录自《编写高质量代码:改善Python程序的91个建议》


Code Review的宗旨如截图很显然了。但是具体执行时,可能还会感觉模糊,作为评审者,应该以什么样的依据做为代码评审依据呢?
为此我总结了一个Checklist,供参考:

  • 代码语法和逻辑是否正确?
  • 方法、函数以及变量命名是否容易理解?
  • 最新修改的部分编码风格是否统一?
  • 存在代码冗长,存在另一段代码片段的副本吗?
  • 代码够模块化吗?
  • 全局变量能否被替代吗?
  • 代码所实现的功能是否在标准库模块中已经实现了呢?
  • 循环语句中代码复杂度高吗,是O(1)、O(n)?可以降低复杂度吗?
  • 用于debug的调试代码,如print、logging,是否可以删掉?
  • 注释信息描述的是代码本身还是其他?

· EOF ·