整个 2020 年,我都在重构一个老的项目(同时在进行业务迭代,边开车边换轮胎)。重构有很多最佳实践,有一本经典的书,就叫《重构》。当然最后重构成什么样,取决于你对编程原则的理解以及是否有代码洁癖。

之前看了一本畅销书《清单革命》,让我认识到了清单的威力,开始使用清单检查代码。下面这个列表就是我最近半年在用的检查清单,给实习生 code review 的时候我也会使用这个清单。我决定把它公布出来,持续更新。

  • 是否存在重复代码?
  • 每个变量名是否清晰的表明了它的作用?
  • 是否存在过长的函数(超过 30 行)?
  • 是否存在魔法数字?
  • 是否在注释里列出了需求文档和后端技术文档链接方便后人查阅?
  • 无用的代码和注释是否全删了?
  • 有特殊处理的地方是否注释写明了特殊处理的原因?
  • 是否有可以抽象出来的工具,供其它项目使用?
  • 是否考虑到了浮点数误差,比如 19.90*100