前端 Code Review 清单

前端 Code Review 清单是一个保证前端代码质量的审查清单。当我们在开发写代码的时候,总会存在各种各样的问题,自测的时候由于太熟悉自己的代码逻辑往往测试不够充分,无法发现问题。为了解决这个问题,清单存放了一些常见的问题,当我们开发完成之后,对照清单思考一下这些问题在代码中是否遇到或者妥善处理,从而提高代码质量。

常规项

  1. 代码是否能正常运行?
  2. 代码是否符合编程规范?
  3. 代码是否简单易懂,逻辑清晰?
  4. 是否存在多余或重复代码?
  5. 是否存在被注释掉的代码?
  6. 是否存在缩进不一致Tab、空格混用?
  7. 变量命名是否简单易懂拼写正确,是否存在未声明即使用的变量,是否存在重复声明的变量?
  8. 循环是否设置了长度和正确的终止条件?
  9. 数组索引是否在允许范围内?
  10. 是否有无用的调试代码?
  11. 数据输入是否都进行了检查(检测正确的类型,长度,格式和范围)并且进行了编码?
  12. CSS 属性是否有拼写错误?
  13. HTML 标签是否书写正确,是否嵌套正确,闭合是否正确?

 

性能

  1. JS 代码是否尽量放在底部?CSS 代码是否尽量放在了顶部?
  2. 是否部署 CDN 或者开启了缓存功能?
  3. 上线或者发布前,是否对静态资源进行打包、压缩处理?
  4. 正确使用预加载、懒加载等技术手段提高性能。
  5. 是否对图片等资源进行压缩以及小图 CSS Sprite 或 base64内嵌?
  6. 关键算法的时间复杂度多少?有没有可能有潜在的性能瓶颈。

 

代码质量

  1. 重复造轮子的问题,常见工具类使用不到位,经常自己写方法实现。
  2. 公共数据使用不充分,存在重复调用的情况。
  3. 代码逻辑不顺畅,存在走弯路的倾向,能精简的代码要反复的重构以达到最优目标。
  4. 参数过多时,可转化为对象传参,否则一个方法的参数要加大代码的可维护性。
  5. 需要异步处理的情况避免同步处理,以免影响主业务流程效率。
  6. 有没有错误处理,如网络异常时发送请求数据

本文链接地址: 前端 Code Review 清单

发表回复

您的电子邮箱地址不会被公开。 必填项已用*标注