码迷,mamicode.com
首页 > 其他好文 > 详细

Vue代码的风格指南

时间:2019-01-28 01:10:51      阅读:308      评论:0      收藏:0      [点我收藏+]

标签:情况下   用法   定制   官方   事件   规范   选择   声明   是什么   

这里是官方的 Vue 特有代码的风格指南(原官方文档链接)。如果在工程中使用 Vue,为了回避错误、小纠结和反模式,该指南是份不错的参考。

我们把所有的规则归为了四个大类:

优先级 A:必要的

这些规则会帮你规避错误,所以学习并接受它们带来的全部代价吧。这里面可能存在例外,但应该非常少,且只有你同时精通 JavaScript 和 Vue 才可以这样做。

优先级 B:强烈推荐

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

优先级 C:推荐

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

  1. 训练你的大脑,以便更容易的处理你在社区遇到的代码;
  2. 不做修改就可以直接复制粘贴社区的代码示例。

优先级 D:谨慎使用

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


 

以下是自己做的梳理,把觉得重要的注意事项和合理的规范列了出来,如果希望了解全部风格指南,请移步原文档。

优先级 A 的规则:必要的 (规避错误)

  1. 组件名应该始终是多个单词的,根组件 App 除外。

  2. 当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方),它的值必须是返回一个对象的函数。

  3. prop 的定义应该尽量详细,至少需要指定其类型。

  4. 在组件上_总是_必须用 key 配合 v-for,以便维护内部组件及其子树的状态。

  5. 永远不要把 v-if 和 v-for 同时用在同一个元素上。
  6. 组件样式设置作用域,对于应用来说,顶级 App 组件和布局组件中的样式可以是全局的,但是其它所有组件都应该是有作用域的。这让覆写内部样式更容易:使用了常人可理解的 class 名称且没有太高的选择器优先级,而且不太会导致冲突。

  7. 在插件、混入等扩展中始终为自定义的私有属性使用 $_ 前缀。并附带一个命名空间以回避和其它作者的冲突 (比如 $_yourPluginName_)。

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

  1. 只要有能够拼接文件的构建系统,就把每个组件单独分成文件。当你需要编辑一个组件或查阅一个组件的用法时,可以更快速的找到它。

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

    单词大写开头对于代码编辑器的自动补全最为友好,因为这使得我们在 JS(X) 和模板中引用组件的方式尽可能的一致。然而,混用文件命名方式有的时候会导致大小写不敏感的文件系统的问题,这也是横线连接命名同样完全可取的原因。

  3. 应用特定样式和约定的基础组件 (也就是展示类的、无逻辑的或无状态的组件) 应该全部以一个特定的前缀开头,比如 BaseApp 或 V
  4. 只应该拥有单个活跃实例的组件应该以 The 前缀命名,以示其唯一性。

    这不意味着组件只可用于一个单页面,而是每个页面只使用一次。这些组件永远不接受任何 prop,因为它们是为你的应用定制的,而不是它们在你的应用中的上下文。如果你发现有必要添加 prop,那就表明这实际上是一个可复用的组件,只是目前在每个页面里只使用一次。

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

    如果一个组件只在某个父组件的场景下有意义,这层关系应该体现在其名字上。因为编辑器通常会按字母顺序组织文件,所以这样做可以把相关联的文件排在一起。

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

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

    自闭合组件表示它们不仅没有内容,而且刻意没有内容。其不同之处就好像书上的一页白纸对比贴有“本页有意留白”标签的白纸。而且没有了额外的闭合标签,你的代码也更简洁。

    不幸的是,HTML 并不支持自闭合的自定义元素——只有官方的“空”元素。所以上述策略仅适用于进入 DOM 之前 Vue 的模板编译器能够触达的地方,然后再产出符合 DOM 规范的 HTML。

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

  9. JS/JSX 中的组件名应该始终是 PascalCase 的,尽管在较为简单的应用中只使用 Vue.component 进行全局组件注册时,可以使用 kebab-case 字符串。
  10. 组件名应该倾向于完整单词而不是缩写。编辑器中的自动补全已经让书写长命名的代价非常之低了,而其带来的明确性却是非常宝贵的。不常用的缩写尤其应该避免。

  11. 在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板和 JSX 中应该始终使用 kebab-case。我们单纯的遵循每个语言的约定。在 JavaScript 中更自然的是 camelCase。而在 HTML 中则是 kebab-case。

  12. 多个特性的元素应该分多行撰写,每个特性一行。在 JavaScript 中,用多行分隔对象的多个属性是很常见的最佳实践,因为这样更易读。

  13. 组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性或方法。复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么,而非如何计算那个值。而且计算属性和方法使得代码可以重用。

  14. 应该把复杂计算属性分割为尽可能多的更简单的属性。易于测试,阅读,和更好的‘拥抱变化‘。
  15. 非空 HTML 特性值应该始终带引号 (单引号或双引号,选你 JS 里不用的那个)。

    在 HTML 中不带空格的特性值是可以没有引号的,但这样做常常导致带空格的特征值被回避,导致其可读性变差。

  16. 指令缩写 (用 : 表示 v-bind: 和用 @ 表示 v-on:) 应该要么都用要么都不用。(我选择都用哈哈)

优先级 C 的规则:推荐 (将选择和认知成本最小化)

  1. 组件/实例的选项应该有统一的顺序。

    这是我们推荐的组件选项默认顺序。它们被划分为几大类,所以你也能知道从插件里添加的新属性应该放到哪里。

  2. 元素 (包括组件) 的特性应该有统一的顺序。

    这是我们为组件选项推荐的默认顺序。它们被划分为几大类,所以你也能知道新添加的自定义特性和指令应该放到哪里。

  3. 你可能想在多个属性之间增加一个空行,特别是在这些选项一屏放不下,需要滚动才能都看到的时候。

    当你的组件开始觉得密集或难以阅读时,在多个属性之间添加空行可以让其变得容易。在一些诸如 Vim 的编辑器里,这样格式化后的选项还能通过键盘被快速导航。

  4. 单文件组件应该总是让 <script><template> 和 <style> 标签的顺序保持一致。且 <style> 要放在最后,因为另外两个标签至少要有一个。

优先级 D 的规则:谨慎使用 (有潜在危险的模式)

  1. 如果一组 v-if + v-else 的元素类型相同,最好使用 key (比如两个 <div> 元素)。

    默认情况下,Vue 会尽可能高效的更新 DOM。这意味着其在相同类型的元素之间切换时,会修补已存在的元素,而不是将旧的元素移除然后在同一位置添加一个新元素。如果本不相同的元素被识别为相同,则会出现意料之外的副作用。

  2. 元素选择器应该避免在 scoped 中出现。

    在 scoped 样式中,类选择器比元素选择器更好,因为大量使用元素选择器是很慢的。

  3. 应该优先通过 prop 和事件进行父子组件之间的通信,而不是 this.$parent 或改变 prop。

    一个理想的 Vue 应用是 prop 向下传递,事件向上传递的。遵循这一约定会让你的组件更易于理解。然而,在一些边界情况下 prop 的变更或 this.$parent 能够简化两个深度耦合的组件。

    问题在于,这种做法在很多_简单_的场景下可能会更方便。但请当心,不要为了一时方便 (少写代码) 而牺牲数据流向的简洁性 (易于理解)。

  4. 应该优先通过 Vuex 管理全局状态,而不是通过 this.$root 或一个全局事件总线。

    通过 this.$root 和/或全局事件总线管理状态在很多简单的情况下都是很方便的,但是并不适用于绝大多数的应用。Vuex 提供的不仅是一个管理状态的中心区域,还是组织、追踪和调试状态变更的好工具。

以上,希望自己能够在今后的开发中严格遵循代码风格,提高代码的可读性和一致性,写出更规范,严谨,漂亮的代码。

小怪兽的是最棒的!(不接受任何反驳)

Vue代码的风格指南

标签:情况下   用法   定制   官方   事件   规范   选择   声明   是什么   

原文地址:https://www.cnblogs.com/lemonmonster/p/10327967.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!