Skip to content

前端开发「规范化」

前言

古人云“无规矩不成方圆”,在做任何事情时都需要有一定的程序、规则或计划,否则难以取得成功或达成目标。

为什么需要规范

统一代码规范的好处:
  1. 提高代码整体的可读性、可维护性、可复用性、可移植性和可靠性,这会从根本上降低开发成本,也是最重要的一点。
  2. 保证代码的一致性:软件系统中最重要的因素之一就是编码的一致性。如果编码风格一致,也更加易于维护,因为团队内任何人都可以快速理解并修改。
  3. 提升团队整体效率:开发人员通常需要花费大量的时间来解决代码质量问题,如果都按照规范编写,也有助于团队尽早发现问题,甚至完全预防问题,这将提高整个交付过程的效率。
  4. 减少code review期间一系列的争议,因为缺乏标准,在争议过程中双方很难妥协(没少因为这事争论过😕)。
若不统一代码规范,可能会造成的后果:
  1. 由于缺乏规范,导致代码风格不一,增加团队成员间的心理负担,极端情况下,某段代码只有某个人能修改(俗称屎山💩)。
  2. 团队间协作更加困难:因为开发人员得适应不同的风格,会导致效率低下(阅读代码是我们花费时间最多的地方)。
  3. 在code review期间可能经常为类似的事情做过多的讨论。
  4. 影响团队的生产力和质量,严重的甚至会影响团队和谐。

规范建立

开发者需要遵循和建立的规范大致可以划分成这几个方向:

  1. 开发流程规范
  2. 项目目录与文件结构规范
  3. 开发代码规范
  4. git commit规范
  5. 前后端接口分离规范

总结

  1. 统一规范的最根本目的是为了保证团队成员的一致性,从而减少沟通成本,提高开发效率。
  2. 学会热爱标准,但要确保它们不是一成不变的。
  3. 如果制定的规范不适合您的团队,请确保可以适应和重写所需要的任何规则。
  4. 它并不是要强制执行一种工作方式,而是为了帮助促进团队之间的互动。

参考

https://mp.weixin.qq.com/s/oqD6PiLtzDgt4giXl-3JHQ