代码规范很重要

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

2.组件的 data 必须是一个函数。

// In a .vue file
export default {data () {return {foo: 'bar'}}
}

3.Prop 定义应该尽量详细。【包含了类型、校验】

// 更好的做法!
props: {status: {type: String,required: true,validator: function (value) {return ['syncing','synced','version-conflict','error'].indexOf(value) !== -1}}
}

类型有:

单向数据流:所有的 prop 都使得其父子 prop 之间形成了一个单向下行绑定:父级 prop 的更新会向下流动到子组件中,但是反过来则不行。

4.总是用 key 配合 v-for

<ul><liv-for="todo in todos":key="todo.id">{{ todo.text }}</li>
</ul>

5.永远不要把 v-if 和 v-for 同时用在同一个元素上。

6.对于应用来说,顶级 App 组件和布局组件中的样式可以是全局的,但是其它所有组件都应该是有作用域的。

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

var myGreatMixin = {// ...
  methods: {$_myGreatMixin_update: function () {// ...
    }}
}

8.只要有能够拼接文件的构建系统,就把每个组件单独分成文件

// 反例
Vue.component('TodoList', {// ...
})Vue.component('TodoItem', {// ...
})// 好例子
components/
|- TodoList.js
|- TodoItem.js
components/
|- TodoList.vue
|- TodoItem.vue

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

// 反例
components/
|- mycomponent.vue
components/
|- myComponent.vue// 好例子
components/
|- MyComponent.vue
components/
|- my-component.vue

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

// 反例
components/
|- MyButton.vue
|- VueTable.vue
|- Icon.vue
// 好例子
components/
|- BaseButton.vue
|- BaseTable.vue
|- BaseIcon.vue
components/
|- AppButton.vue
|- AppTable.vue
|- AppIcon.vue
components/
|- VButton.vue
|- VTable.vue
|- VIcon.vue

11.只应该拥有单个活跃实例的组件应该以 The 前缀命名,以示其唯一性。

// 反例
components/
|- Heading.vue
|- MySidebar.vue// 好例子
components/
|- TheHeading.vue
|- TheSidebar.vue

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

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

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

反例
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent></MyComponent>
<!-- 在 DOM 模板中 -->
<my-component/>
好例子
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>

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

反例
<!-- 在单文件组件和字符串模板中 -->
<mycomponent/>
<!-- 在单文件组件和字符串模板中 -->
<myComponent/>
<!-- 在 DOM 模板中 -->
<MyComponent></MyComponent>
好例子
<!-- 在单文件组件和字符串模板中 -->
<MyComponent/>
<!-- 在 DOM 模板中 -->
<my-component></my-component>
或者
<!-- 在所有地方 -->
<my-component></my-component>

16.尽管在较为简单的应用中只使用 Vue.component 进行全局组件注册时,可以使用 kebab-case 字符串。但是JS/JSX 中的组件名应该始终是 PascalCase 的

// 反例
Vue.component('myComponent', {// ...
})
import myComponent from './MyComponent.vue'
export default {name: 'myComponent',// ...
}
export default {name: 'my-component',// ...
}
// 好例子
Vue.component('MyComponent', {// ...
})
Vue.component('my-component', {// ...
})
import MyComponent from './MyComponent.vue'
export default {name: 'MyComponent',// ...
}

17.组件名应该倾向于完整单词而不是缩写。

18.在声明 prop 的时候,其命名应该始终使用 camelCase,而在模板和 JSX 中应该始终使用 kebab-case

// 反例
props: {'greeting-text': String
}
<WelcomeMessage greetingText="hi"/>
// 好例子
props: {greetingText: String
}
<WelcomeMessage greeting-text="hi"/>

19.多个属性的元素应该分多行撰写,每个属性一行。

<!--反例-->
<img src="https://vuejs.org/images/logo.png" alt="Vue Logo">
<MyComponent foo="a" bar="b" baz="c"/>
<!--好例子-->
<imgsrc="https://vuejs.org/images/logo.png"alt="Vue Logo"
>
<MyComponentfoo="a"bar="b"baz="c"
/>

20.组件模板应该只包含简单的表达式,复杂的表达式则应该重构为计算属性(Computed)或方法(Methods)

// 反例
{{fullName.split(' ').map(function (word) {return word[0].toUpperCase() + word.slice(1)}).join(' ')
}}
// 好例子
<!-- 在模板中 -->
{{ normalizedFullName }}
// 复杂表达式已经移入一个计算属性
computed: {normalizedFullName: function () {return this.fullName.split(' ').map(function (word) {return word[0].toUpperCase() + word.slice(1)}).join(' ')}
}

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

// 反例
computed: {price: function () {var basePrice = this.manufactureCost / (1 - this.profitMargin)return (basePrice -basePrice * (this.discountPercent || 0))}
}
// 好例子
computed: {basePrice: function () {return this.manufactureCost / (1 - this.profitMargin)},discount: function () {return this.basePrice * (this.discountPercent || 0)},finalPrice: function () {return this.basePrice - this.discount}
}

22.非空 HTML 属性值应该始终带引号 (单引号或双引号,选你 JS 里不用的那个)。

<!--反例-->
<input type=text>
<AppSidebar :style={width:sidebarWidth+'px'}>
<!--好例子-->
<input type="text">
<AppSidebar :style="{ width: sidebarWidth + 'px' }">

23.指令缩写 (用 : 表示 v-bind: 和用 @ 表示 v-on:) 应该要么都用要么都不用

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

好例子
<!-- ComponentA.vue -->
<script>/* ... */</script>
<template>...</template>
<style>/* ... */</style><!-- ComponentA.vue -->
<template>...</template>
<script>/* ... */</script>
<style>/* ... */</style>

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

<!--反例-->
<div v-if="error">错误:{{ error }}
</div>
<div v-else>{{ results }}
</div>
<!--好例子-->
<divv-if="error"key="search-status"
>错误:{{ error }}
</div>
<divv-elsekey="search-results"
>{{ results }}
</div><p v-if="error">错误:{{ error }}
</p>
<div v-else>{{ results }}
</div>

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

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

28.自定义事件:始终使用 kebab-case 的事件名

转载于:https://www.cnblogs.com/LUA123/p/10326881.html

Vue(五)Vue规范相关推荐

  1. Vue前端开发规范及代码风格

    Vue.js 开发规范目录及说明 版本 v1.0 日期 2020-02-18 本文档为前端 vue 开发规范 规范目的 命名规范 结构化规范 注释规范 编码规范 CSS 规范 规范目的 为提高团队协作 ...

  2. 【Vue五分钟】五分钟了解--Vue过渡

    目录 前言 一.vue里面的transition组件 二.transition组件应用CSS过渡 (1)单元数/组件过渡 (2)多个元素过渡 (3)多个组件过渡 (4)列表过渡 三.JavaScrip ...

  3. 前端:Vue前端开发规范,值得收藏!

    一.强制 1. 组件名为多个单词 组件名应该始终是多个单词的,根组件 App 除外. 正例: export default {name: 'TodoItem',// ... } 复制代码 反例: ex ...

  4. 猿创征文|【Vue五分钟】 Vue Cli脚手架创建一个项目

    目录 前言 一.创建项目的操作步骤 选择路由模式 选择CSS预编译器 选择如何存放配置 自动下载项目所需的包文件 二.启动vue项目 1.项目目录 2.启动项目 3.浏览器打开项目首页界面 三.项目的 ...

  5. 【VUE】Vue知识点整理

    vue 基本概念 作者: 尤雨溪 渐进式 的 自底向上增量开发的 mvvm框架 渐进式 可以和多种框架进行合并 vue是一个渐进式的框架(vue只会按照程序员的需要来进行功能的实现 不会影响到项目中没 ...

  6. VUE|VUE前端开发--基本语法

    VUE|基本语法 一.声明式渲染 ◼ hellovue1.html <html> <head><title>HelloWorld!</title>< ...

  7. 【狂神Vue】Vue,ElmentUI

    Vue Vue(读音/vju/, 类似于view) 是一套用于构建用户界面的渐进式框架, 发布于2014年2月.与其它大型框架不同的是, Vue被设计为可以自底向上逐层应用.Vue的核心库只关注视图层 ...

  8. Vue学习笔记(一)—— 什么时候需要import Vue from 'vue'

    一.当执行 import vue from 'vue' 时发生了什么? 其实在 node.js 中,执行 import 就相当于执行了 require,而 require 被调用,就会用到 requi ...

  9. VUE系列-Vue中组件的应用(三)

    ​ 大家好,我是前端岚枫,一枚二线城市的程序媛,上篇主要跟分享了<VUE系列-Vue核心应用(二)>,今天主要跟大家分享我整理的vue的组件相关的,主要包括组件声明.组件种类.组件间的几种 ...

  10. VUE系列-Vue核心应用(二)

    大家好,我是前端岚枫,一枚二线城市的程序媛,上篇主要跟分享了<Vue核心概念及特性 (一)>,今天主要跟大家分享我整理的vue的一些常用的核心应用,主要包括一些表单组件.自定义指令.修饰符 ...

最新文章

  1. IPV6的设置问题!
  2. 【ACM】杭电OJ 1106 函数atoi
  3. ASP.NET MVC Model绑定小结
  4. 征战蓝桥 —— 2018年第九届 —— C/C++B组第1题——第几天
  5. 你以为的论文答辩,实际的论文答辩,看着看着就哭系列
  6. ECS上搭建Docker(CentOS7)
  7. 远程查看室内亮暗情况
  8. java 时间换算_【时间工具】整理下java时间换算专题
  9. js日期格式化写法及获取当前日期年月日、上一月
  10. 简述什么是 Cloud Native
  11. 读书笔记--疯狂Android讲义 目录
  12. 一文带你了解SQL的执行计划(explain)
  13. Java项目部署到远程服务器(详细步骤)
  14. 长微博android,凑合着用吧:Android版长微博
  15. wpsppt页面卷曲在哪里_用PPT制作页面卷角效果,你会吗?
  16. Spring cloud网关gateway代理websocket报Max frame length of 65536 has been exceeded
  17. VMware中共享文件夹功能的使用(ubuntu)
  18. supervisor控制台运行出错,BACKOFF Exited too quickly
  19. java 创建新的图片,底色自己设定
  20. JavaWeb25.3【综合案例:注册功能(含邮箱激活账号)】

热门文章

  1. console程序显示彩色文字 .
  2. 三月疯狂——最终结果 / March Madness – Final Score
  3. 一步步教你如何用疯狂.NET架构中的通用权限系统 -- 如何控制用户显示的菜单权限...
  4. 将 Firefox 浏览器的书签导出
  5. 数据库原理上机实验内容报告代码
  6. 在linux中安装软件会出的问题,linux中安装程序出现的问题
  7. 问题 | CSDN编辑图像怎么使图像居中、偏左、偏右
  8. Qt学习(九):QT中使用线程
  9. EM算法matlab和Java实现
  10. SQLite学习手册(C/C++接口简介)