总结一下Vue书写规范

• 多个特性的元素规范
• 元素特性的顺序
• 组件选项顺序
• 注释规范
• 编码规范
• 解构赋值
• 指令规范
• Props 规范

上一篇总结了一部分书写规则，可以点第一篇VUE书写规范 查看一下，回顾回顾的

多个特性的元素规范

多个特性的元素应该分多行撰写，每个特性一行。(增强更易读)

元素特性的顺序

原生属性放前面，指令放后面
如下所示：

- class
- id,ref
- name
- data-*
- src, for, type, href,value,max-length,max,min,pattern
- title, alt，placeholder
- aria-*, role
- required,readonly,disabled
- is
- v-for
- key
- v-if
- v-else-if
- v-else
- v-show
- v-cloak
- v-pre
- v-once
- v-model
- v-bind,:
- v-on,@
- v-html
- v-text

组件选项顺序

如下所示：

- components
- props
- data
- computed
- created
- mounted
- metods
- filter
- watch

注释规范

代码注释在一个项目的后期维护中显的尤为重要，所以我们要为每一个被复用的组件编写组件使用说明，为组件中每一个方法编写方法说明
务必添加注释列表，公共组件使用说明，各组件中重要函数或者类说明，复杂的业务逻辑处理说明，特殊情况的代码处理说明,对于代码中特殊用途的变量、存在临界值、函数中使用的 hack、使用了某种算法或思路等需要进行注释描述、

多重 if 判断语句
注释块必须以 /（至少两个星号）开头/
单行注释使用//
单行注释
注释单独一行，不要在代码后的同一行内加注释。例如：

bad
var name =”abc”; // 姓名
good
// 姓名var name = “abc”;       
多行注释
组件使用说明，和调用说明
/**
* 组件名称
* @module 组件存放位置
* @desc 组件描述
* @author 组件作者
* @date 2017年12月05日17:22:43
* @param {Object} [title]    - 参数说明
* @param {String} [columns] - 参数说明
* @example 调用示例
*  
**/

编码规范

优秀的项目源码，即使是多人开发，看代码也如出一人之手。统一的编码规范，可使代码更易于阅读，易于理解，易于维护。尽量按照 ESLint 格式要求编写代码

源码风格
使用 ES6 风格编码
定义变量使用 let ,定义常量使用 const
静态字符串一律使用单引号或反引号，动态字符串使用反引号

// bad
const a = 'foobar'
const b = 'foo' + a + 'bar'
// acceptable
const c = `foobar`
// good
const a = 'foobar'
const b = `foo${a}bar`
const c = 'foobar'

解构赋值

数组成员对变量赋值时，优先使用解构赋值

// 数组解构赋值
const arr = [1, 2, 3, 4]
// bad
const first = arr[0]
const second = arr[1]
// good
const [first, second] = arr

函数的参数如果是对象的成员，优先使用解构赋值

// 对象解构赋值
// bad
function getFullName(user) {
const firstName = user.firstName
const lastName = user.lastName
}
// good
function getFullName(obj) {
const { firstName, lastName } = obj
}
// best
function getFullName({ firstName, lastName }) {}

拷贝数组

使用扩展运算符（…）拷贝数组。

const items = [1, 2, 3, 4, 5]
// bad
const itemsCopy = items
// good
const itemsCopy = [...items]

箭头函数

需要使用函数表达式的场合，尽量用箭头函数代替。因为这样更简洁，而且绑定了 this

// bad
const self = this;
const boundMethod = function(...params) {
returnapply(self, params);
}
// acceptable
const boundMethod = method.bind(this);
// best
const boundMethod = (...params) => method.apply(this, params);

模块

如果模块只有一个输出值，就使用 export default，如果模块有多个输出值，就不使用 export default，export default 与普通的 export 不要同时使用

// bad
import * as myObject from './importModule'
// good
import myObject from './importModule'

如果模块默认输出一个函数，函数名的首字母应该小写。

function makeStyleGuide() {
}
export default makeStyleGuide;

如果模块默认输出一个对象，对象名的首字母应该大写。

const StyleGuide = {
es6: {
}
};export default StyleGuide

指令规范

指令有缩写一律采用缩写形式

// bad
v-bind:class="{'show-left'：true}"
v-on:click="getListData"
// good
:class="{'show-left'：true}"
@click="getListData"

v-for 循环必须加上 key 属性，在整个 for 循环中 key 需要唯一

{{ todo.text }}





{{ todo.text }}

避免 v-if 和 v-for 同时用在一个元素上（性能问题）
以下为两种解决方案：
将数据替换为一个计算属性，让其返回过滤后的列表

{{ user.name }}





{{ user.name }}

将 v-if 移动至容器元素上 (比如 ul, ol)

{{ user.name }}





{{ user.name }}

Props 规范

Props 定义应该尽量详细

// bad 这样做只有开发原型系统时可以接受
props: ['status']
// good
props: {
status: {
type: String,
required: true,
validator: function (value) {
return [
'syncing',
'synced',
'version-conflict',
'error'
].indexOf(value) !== -1
}
}
}

其他：避免 this.$parent
调试信息 console.log() debugger 使用完及时删除
除了三目运算，if,else 等禁止简写

// bad
if (true)
alert(name);
log(name);
// bad
if (true)
alert(name);
log(name)
// good
if (true) {
alert(name);
}
log(name);

接下来还会继续总结，请持续关注哦。