风格指南
这是Vue特定代码的官方风格指南。如果你在项目中使用Vue,它是一个很好的参考,可以避免错误、无谓的争论和反模式。然而,我们不认为任何风格指南都适合所有团队或项目,所以鼓励基于以往经验、周边技术栈和个人价值观进行有意识的偏离。
就大部分而言,我们也避免了一般JavaScript或HTML的建议。我们不介意你是否使用分号或尾随逗号。我们不介意你的HTML在属性值中是否使用单引号或双引号。然而,某些例外将存在,因为我们发现Vue上下文中某个特定模式是有帮助的。
最后,我们将规则分为四个类别
规则类别
优先级A:基本(错误预防)
这些规则有助于预防错误,所以不惜一切代价学习和遵守它们。虽然可能存在例外,但这些例外应该非常罕见,并且只有那些对JavaScript和Vue都有专家知识的人才能做出。
优先级B:强烈推荐
这些规则在大多数项目中被发现可以改善可读性和/或开发者体验。即使违反这些规则,代码仍然可以运行,但违规应该很少,并且有很好的理由。
优先级C:推荐
当存在多个同等好的选项时,可以选择任意一个以确保一致性。在这些规则中,我们描述了每个可接受的选项,并建议了一个默认选择。这意味着你可以在自己的代码库中自由地做出不同的选择,只要你保持一致并有合理的理由。但请务必有合理的理由!通过适应社区标准,你将
- 训练你的大脑,以便更容易地解析你遇到的社区代码的大部分内容
- 能够复制并粘贴大多数社区代码示例,无需修改
- 通常发现新员工已经习惯了你的首选编码风格,至少在Vue方面是这样
优先级D:谨慎使用
Vue的一些功能是为了适应罕见的边缘情况或从旧代码库中更平滑地迁移。然而,过度使用它们可能会使你的代码更难以维护,甚至可能成为错误的原因。这些规则突出了潜在的有风险的功能,描述了何时以及为什么应该避免它们。