代码风格


# 代码风格

团队关于代码风格必须遵循两个基本原则:少数服从多数、用工具统一风格。


Tips:

  • 在一个项目中,永远遵循同一套编码规范。
  • 这里整理的代码风格我在个人项目中遵循的,具体需要根据所在团队和项目的变化而调整。
  • 参与和维护其他人的项目时,秉承入乡随俗的原则,尊重别人代码的风格习惯。

与其自己建立编码规范,更推荐选择社区沉淀下来的规范。因此,在制定代码风格指南时,主要借鉴了一些大厂和开源组织的前端代码规范:


用工具统一风格是一个很好的选择:

ESLint 和 Prettier 区别:

  • ESLint(包括其他一些 Lint 工具)主要解决的是代码质量问题
  • Prettier 主要解决的是代码风格问题

代码质量出问题意味着程序有潜在 Bug(未使用变量、三等号、全局变量声明等),而风格问题充其量也只是看着不爽(单行代码长度、tab 长度、空格、逗号表达式等)。

一般可以使用 Prettier + ESLint 来同时解决两个问题,但需要通过 eslint-config-prettier 插件来解决两个规则同时使用时的冲突问题。