• 首页
  • css3教程
  • html5教程
  • jQuery手册
  • vue手册
  • php手册
  • MySQL手册
  • apache手册
  • redis手册
  • 风格指南

    本文是针对 Vue 代码的官方风格指南。如果你在工程中使用了 Vue,本文可以帮助你回避错误和反模式,减少对细枝末节的过度纠结。不过,我们认为任何风格指南都不会完美适用于所有的团队或项目。因此,我们也建议你根据过去的经验、周边的技术栈或个人价值观来做出有意识的调整。

    对于其中的绝大部分,我们也总体上避免就 JavaScript 或 HTML 本身提出建议。我们不介意你是否使用分号或尾逗号,也不介意你在 HTML attribute 中使用单引号还是双引号。不过,当我们发现某个特定模式在 Vue 语境中很有用时,也会存在例外。

    最终,我们把规则归为了四个大类:


    优先级 A:必要的

    这些规则会帮你规避错误,所以请务必学习并遵守它们。可能存在例外的情况,但应该非常少,而且需要同时精通 JavaScript 和 Vue 的人来决定。


    优先级 B:强烈推荐

    这些规则能够在绝大多数工程中改善可读性和开发体验。即使你违反了它们,代码还是能照常运行。但此类例外应该尽可能地少,且有充分的理由。


    优先级 C:推荐

    当存在有多个同样好的选项时,可以选择其中任意一项以确保一致性。在这些规则里,我们描述每个可取的选项,并建议使用一个默认的。也就是说,只要保持一致且理由充分,你可以自由地在代码库中做出不同的选择。不过,请务必给出一个好的理由!通过接受社区的标准,你将会:

    • 训练你的大脑,以便更容易的处理你在社区遇到的代码;
    • 不做修改就可以直接复制粘贴社区的代码示例;
    • 能够经常招聘到和你编码习惯相同的新人,至少在 Vue 的领域。


    优先级 D:谨慎使用

    某些 Vue 特性的存在是为了照顾极端情况,或帮助老代码平稳迁移。当被过度使用时,这些特性会让代码难以维护,甚至变成 bug 的来源。这些规则的存在是为了给有潜在风险的特性敲响警钟,说明它们在哪些时候应该被避免使用,以及为什么。