Vue风格指南

官网文档：https://cn.vuejs.org/v2/style-guide/。Vue将风格指南归于四个大类：

• 优先级 A：必要的

这些规则会帮你规避错误。

• 优先级 B：强烈推荐

这些规则能够在绝大多数工程中改善可读性和开发体验。即使你违反了，代码还是能照常运行。

• 优先级 C：推荐

当存在多个同样好的选项，选任意一个都可以确保一致性。在这些规则里，我们描述了每个选项并建议一个默认的选择。

• 优先级 D：谨慎使用

有些 Vue 特性的存在是为了照顾极端情况或帮助老代码的平稳迁移。当被过度使用时，这些特性会让你的代码难于维护甚至变成 bug 的来源。

1. 优先级 A 的规则：必要的 (规避错误)

• 组件名为多个单词：组件名应该始终是多个单词的，根组件 App 以及 、 之类的 Vue 内置组件除外。这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。

• 组件的 data 必须是一个函数：当 data 的值是一个对象时，它会在这个组件的所有实例之间共享。这样一个实例修改data时，其他实例也会受到影响。我们希望每个组件实例都管理其自己的数据。为了做到这一点，每个实例必须生成一个独立的数据对象。在 JavaScript 中，在一个函数中返回这个对象就可以了。

• Prop 定义应该尽量详细：prop 的定义应该尽量详细，至少需要指定其类型。

• 为 v-for 设置键值

• 永远不要把 v-if 和 v-for 同时用在同一个元素上：当 Vue 处理指令时，v-for 比 v-if 具有更高的优先级。一般我们在两种常见的情况下会倾向于这样做：

  • 1.为了过滤一个列表中的项目 (比如 v-for=“user in users” v-if=“user.isActive”)。在这种情形下，请将 users 替换为一个计算属性 (比如 activeUsers)，让其返回过滤后的列表。

  • 2.为了避免渲染本应该被隐藏的列表 (比如 v-for=“user in users” v-if=“shouldShowUsers”)。这种情形下，请将 v-if 移动至容器元素上 (比如 ul, ol)。

• 为组件样式设置作用域:对于应用来说，顶级 App 组件和布局组件中的样式可以是全局的，但是其它所有组件都应该是有作用域的。

2. 优先级 B 的规则：强烈推荐 (增强可读性)

• 组件文件 ：只要有能够拼接文件的构建系统，就把每个组件单独分成文件。

• 单文件组件文件的大小写：单文件组件的文件名应该要么始终是单词大写开头 (PascalCase)，要么始终是横线连接 (kebab-case)。

• 基础组件名 ：应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头，比如 Base、App 或 V。

• 单例组件名 ：只应该拥有单个活跃实例的组件应该以 The 前缀命名，以示其唯一性。这不意味着组件只可用于一个单页面，而是每个页面只使用一次。这些组件永远不接受任何 prop，因为它们是为你的应用定制的，而不是它们在你的应用中的上下文。如果你发现有必要添加 prop，那就表明这实际上是一个可复用的组件，只是目前在每个页面里只使用一次。

• 紧密耦合的组件名 ：和父组件紧密耦合的子组件应该以父组件名作为前缀命名。

• 组件名中的单词顺序 ：组件名应该以高级别的 (通常是一般化描述的) 单词开头，以描述性的修饰词结尾。

• 自闭合组件：在单文件组件、字符串模板和 JSX 中没有内容的组件应该是自闭合的——但在 DOM 模板里永远不要这样做。

• 模板中的组件名大小写 ：对于绝大多数项目来说，在单文件组件和字符串模板中组件名应该总是 PascalCase 的——但是在 DOM 模板中总是 kebab-case 的。

• Prop 名大小写 ：在声明 prop 的时候，其命名应该始终使用 camelCase，而在模板和 JSX 中应该始终使用 kebab-case。

• 模板中简单的表达式 ：组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法。

• 简单的计算属性 ：应该把复杂计算属性分割为尽可能多的更简单的属性。

• 指令缩写 ：指令缩写 (用 : 表示 v-bind: 、用 @ 表示 v-on: 和用 # 表示 v-slot:) 应该要么都用要么都不用。