知海

风格指南

Vue风格指南

风格指南 {#style-guide}

本文档是 Vue 特定代码的官方风格指南。如果你在项目中使用 Vue,这是一份很好的参考,可以避免错误、无谓的争论和反模式。然而,我们并不认为任何风格指南对所有的团队或项目都是理想的,因此鼓励基于过往经验、周围的技术栈和个人价值观进行有意识的偏离。

在大多数情况下,我们也避免提出关于 JavaScript 或 HTML 的通用建议。我们不介意你是否使用分号或尾随逗号;也不介意你的 HTML 属性值是使用单引号还是双引号。当然,也存在一些例外情况,因为我们发现某些特定模式在 Vue 的上下文中是有帮助的。

最后,我们将规则分为四个类别:

规则分类 {#rule-categories}

优先级 A:必要(避免错误) {#priority-a-essential-error-prevention}

这些规则有助于避免错误,因此请务必学习并遵守。例外情况可能存在,但应当非常罕见,并且只能由对 JavaScript 和 Vue 都有专业知识的专家做出。

优先级 B:强烈推荐 {#priority-b-strongly-recommended}

这些规则已被发现在大多数项目中能够提高可读性和/或开发者体验。如果你违反它们,代码仍然可以运行,但违规行为应当很少见且理由充分。

优先级 C:推荐 {#priority-c-recommended}

当存在多个同样良好的选项时,可以做出任意选择以确保一致性。在这些规则中,我们描述了每个可接受的选项,并建议一个默认选择。这意味着你可以在自己的代码库中自由地做出不同的选择,只要保持一致并且有充分的理由。但请务必有充分的理由!通过适应社区标准,你将:

  1. 训练你的大脑,更轻松地解析你遇到的大多数社区代码
  2. 能够不加修改地复制和粘贴大多数社区代码示例
  3. 经常发现新员工已经习惯了你偏好的编码风格,至少在 Vue 方面是如此

优先级 D:谨慎使用 {#priority-d-use-with-caution}

Vue 的某些功能是为了适应罕见的边缘情况或从旧代码库更平滑地迁移而存在的。然而,如果过度使用,它们可能使你的代码更难维护,甚至成为 bug 的来源。这些规则揭示了潜在风险的功能,描述了何时以及为什么应该避免它们。

帮助我们改进文档

发现翻译问题或内容错误?请告诉我们。