代码规范

[TOC]

1.编程规范

一.命名规范

1.1.1 项目命名

全部采用小写方式，以中划线分隔。

正例：mall-management-system
反例：mall_management-system / mallManagementSystem

1.1.2 目录命名

全部采用小写方式，以中划线分隔，有复数结构时，要采用复数命名法，缩写不用复数

正例： scripts / styles / components / images / utils / layouts / demo-styles / demo-scripts / img / doc
反例： script / style / demo_scripts / demoStyles / imgs / docs

VUE 的项目中的 components 中的组件目录，使用 kebab-case 命名

正例： head-search / page-loading / authorized / notice-icon
反例： HeadSearch / PageLoading

VUE 的项目中的除 components 组件目录外的所有目录也使用 kebab-case 命名
正例： page-one / shopping-car / user-management
反例： ShoppingCar / UserManagement

1.1.3 JS、CSS、SCSS、HTML、PNG 文件命名

全部采用小写方式，以中划线分隔
正例： render-dom.js / signup.css / index.html / company-logo.png
反例： renderDom.js / UserManagement.html

1.1.4 命名严谨性

代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用

正例：henan / luoyang / rmb 等国际通用的名称，可视同英文。
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

杜绝完全不规范的缩写，避免望文不知义：
反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。

二. HTML 类型(vue template)

1.2.1 缩进

缩进使用 2 个空格（一个 tab）
嵌套的节点应该缩进。

1.2.2 分块注释

在每一个块状元素，列表元素和表格元素后，加上一对 HTML 注释。注释格式

<body>  <header> <div class="container"> <a href="#">  <img src="images/header.jpg" /> </a> </div> </header>  </body>

1.2.3 语义化标签

HTML5 中新增很多语义化标签，所以优先使用语义化标签，避免一个页面都是 div 或者 p 标签

<header></header> <footer></footer>

1.2.4 引号

使用双引号(“ “) 而不是单引号(‘ ‘) 。

三.css规范

1.3.1 命名

类名使用小写字母，以中划线分隔
id 采用驼峰式命名
scss 中的变量、函数、混合、placeholder 采用驼峰式命名

ID 和 class 的名称总是使用可以反应元素目的和用途的名称，或其他通用的名称，代替表象和晦涩难懂的名称

`.heavy {
font-weight: 800;
}

.important {
color: red;
}`

1.3.1 选择器

1)如果你不写很通用的，需要匹配到 DOM 末端的选择器，你应该总是考虑直接子选择器。

.content > .title { font-size: 2rem; }

1.3.2 尽量使用缩写属性

不推荐：
border-top-style: none; font-family: palatino, georgia, serif; font-size: 100%; line-height: 1.6; padding-bottom: 2em; padding-left: 1em; padding-right: 1em; padding-top: 0;

推荐：
border-top: 0; font: 100%/1.6 palatino, georgia, serif; padding: 0 1em 2em;

1.3.3 每个选择器及属性独占一行

不推荐：
button{ width:100px;height:50px;color:#fff;background:#00a0e9; }

推荐：
button{ width:100px; height:50px; color:#fff; background:#00a0e9; }

1.3.4 省略0后面的单位

不推荐：
div{ padding-bottom: 0px; margin: 0em; }

推荐：
div{ padding-bottom: 0; margin: 0; }

四. scss规范

1.4.1 代码组织

1) 将公共 less 文件放置在 style / less / common 文件夹

例:// color.less,common.less

2) 按以下顺序组织

1、@import;
2、变量声明;
3、样式声明;

`@import “mixins/size.less”;

@default-text-color: #333;

.page {
width: 960px;
margin: 0 auto;
}`

1.4.2 避免嵌套层级过多

将嵌套深度限制在 3 级。对于超过 4 级的嵌套，给予重新评估。这可以避免出现过于详实的 CSS 选择器。

不推荐：
.main{ .title{ .name{ color:#fff } } }

推荐：
.main-title{ .name{ color:#fff } }

五. Javascript 规范

1.5.1 命名

1) 采用小写驼峰命名 lowerCamelCase，代码中的命名均不能以下划线，也不能以下划线或美元符号结束

反例： name / name / name$

2) 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。

正例： localValue / getHttpMessage() / inputUserId

其中 method 方法命名必须是动词+名词形式

正例：saveShopCarData /openShopCarInfoDialog
反例：save / open / show / go

特此说明，增删查改，详情统一使用如下 5 个单词，不得使用其他（目的是为了统一各个端）

**add / update / delete / detail / get**

附：函数方法常用的动词:

get 获取/set 设置, add 增加/remove 删除 create 创建/destory 移除 start 启动/stop 停止 open 打开/close 关闭, read 读取/write 写入 load 载入/save 保存, create 创建/destroy 销毁 begin 开始/end 结束, backup 备份/restore 恢复 import 导入/export 导出, split 分割/merge 合并 inject 注入/extract 提取, attach 附着/detach 脱离 bind 绑定/separate 分离, view 查看/browse 浏览 edit 编辑/modify 修改, select 选取/mark 标记 copy 复制/paste 粘贴, undo 撤销/redo 重做 insert 插入/delete 移除, add 加入/append 添加 clean 清理/clear 清除, index 索引/sort 排序 find 查找/search 搜索, increase 增加/decrease 减少 play 播放/pause 暂停, launch 启动/run 运行 compile 编译/execute 执行, debug 调试/trace 跟踪 observe 观察/listen 监听, build 构建/publish 发布 input 输入/output 输出, encode 编码/decode 解码 encrypt 加密/decrypt 解密, compress 压缩/decompress 解压缩 pack 打包/unpack 解包, parse 解析/emit 生成 connect 连接/disconnect 断开, send 发送/receive 接收 download 下载/upload 上传, refresh 刷新/synchronize 同步 update 更新/revert 复原, lock 锁定/unlock 解锁 check out 签出/check in 签入, submit 提交/commit 交付 push 推/pull 拉, expand 展开/collapse 折叠 begin 起始/end 结束, start 开始/finish 完成 enter 进入/exit 退出, abort 放弃/quit 离开 obsolete 废弃/depreciate 废旧, collect 收集/aggregate 聚集

3) 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

正例： MAX_STOCK_COUNT
反例： MAX_COUNT

1.5.2 代码格式

1) 使用 2 个空格进行缩进（一个tab）

2) 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

1.5.3 字符串

统一使用单引号(‘)，不使用双引号(“)。这在创建 HTML 字符串非常有好处：

正例:

let str = 'foo'; let testDiv = '<div id="test"></div>';

反例:

let str = 'foo'; let testDiv = "<div id='test'></div>";

1.5.4 对象声明

1) 使用字面值创建对象

正例： let user = {};
反例： let user = new Object();

2) 使用字面量来代替对象构造器

正例：

var user = { age: 0, name: 1, city: 3 };

反例：

var user = new Object(); user.age = 0; user.name = 0; user.city = 0;

1.5.5 使用 ES6,ES7

必须优先使用 ES6,ES7 中新增的语法糖和函数。这将简化你的程序，并让你的代码更加灵活和可复用。

必须强制使用 ES6, ES7 的新语法，比如箭头函数、await/async，解构，let，for…of 等等

1.5.6 括号

下列关键字后必须有大括号（即使代码块的内容只有一行）：if, else, for, while, do, switch, try, catch, finally, with。

正例：

if (condition) { doSomething(); }

反例：

if (condition) doSomething();

1.5.7 undefined 判断

永远不要直接使用 undefined 进行变量判断；使用 typeof 和字符串 ‘undefined’ 对变量进行判断。

正例：

if (typeof person === 'undefined') { ... }

反例：1

// person 为 null 也是 true if (person == undefined) { ... }

反例：2 MDN 也有说明

`if (person === undefined) {
…
}

// JavaScript 设计问题， undefined 可以全局作用域中被当作标识符（变量名）来使用
// 因为 undefined 不是一个保留字
// 不要这样做！

// 打印 ‘foo string’ PS：说明undefined的值和类型都已经改变
(function() {
var undefined = ‘foo’;
console.log(undefined, typeof undefined)
})()

// 打印 ‘foo string’ PS：说明undefined的值和类型都已经改变
(function(undefined) {
console.log(undefined, typeof undefined)
})(‘foo’)`

1.5.8 条件判断和循环最多三层

条件判断能使用三目运算符和逻辑运算符解决的，就不要使用条件判断，但是谨记不要写太长的三目运算符。如果超过 3 层请抽成函数，并写清楚注释。

1.5.9 this 的转换命名

对上下文 this 的引用只能使用 self 来命名

1.5.10 慎用 console.log

因 console.log 大量使用会有性能问题，所以在非 webpack 项目中谨慎使用 log 功能

二、Vue 项目规范

(一) Vue 编码基础

二、Vue 项目规范以 Vue 官方规范（https://cn.vuejs.org/v2/style-guide/）中的 A 规范为基础，在其上面进行项目开发，故所有代码均遵守该规范

2.1.1. 组件规范

1) 组件名为多个单词。

组件名应该始终是多个单词组成（大于等于 2），且命名规范为 KebabCase 格式。
这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。

正例：

export default { name: 'TodoItem' // ... };

反例：

export default { name: 'Todo', // ... } export default { name: 'todo-item', // ... }

2) 组件文件名为 pascal-case 格式

components/ |- my-component.vue

components/ |- myComponent.vue |- MyComponent.vue

3) 基础组件文件名为 base 开头，使用完整单词而不是缩写。

正例：

components/ |- base-button.vue |- base-table.vue |- base-icon.vue

反例：

components/ |- TodoList.vue |- TodoItem.vue |- TodoButton.vue |- UProfOpts.vue （使用了缩写）

5) 在 Template 模版中使用组件，应使用 PascalCase 模式，并且使用自闭合组件。
正例：

 <MyComponent /> <Row><table :column="data"/></Row>

反例：

<my-component /> <row><table :column="data"/></row>

6) 组件的 data 必须是一个函数

当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方)，它的值必须是返回一个对象的函数。因为如果直接是一个对象的话，子组件之间的属性值会互相影响。

正例：
export default { data () { return { name: 'jack' } } }

反例：
export default { data: { name: 'jack' } }

7) Prop 定义应该尽量详细

必须使用 camelCase 驼峰命名
必须指定类型
必须加上注释，表明其含义
必须加上 required 或者 default，两者二选其一
如果有业务需要，必须加上 validator 验证

正例：
props: { // 组件状态，用于控制组件的颜色 status: { type: String, required: true, validator: function (value) { return [ 'succ', 'info', 'error' ].indexOf(value) !== -1 } }, // 用户级别，用于显示皇冠个数 userLevel：{ type: String, required: true } }

8) 为组件样式设置作用域

正例：
`

反例：
<template> <button class="btn btn-close">X</button> </template>  <style> .btn-close { background-color: red; } </style>

9) 如果特性元素较多，应该主动换行。

正例：
<MyComponent foo="a" bar="b" baz="c" foo="a" bar="b" baz="c" foo="a" bar="b" baz="c" />

反例：
<MyComponent foo="a" bar="b" baz="c" foo="a" bar="b" baz="c" foo="a" bar="b" baz="c" foo="a" bar="b" baz="c"/>

2.1.2. 模板中使用简单的表达式

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

正例：
`

**反例：<template> {{ fullName.split(' ').map(function (word) { return word[0].toUpperCase() + word.slice(1) }).join(' ') }} </template>

2.1.3 指令都使用缩写形式

指令推荐都使用缩写形式，(用 : 表示 v-bind: 、用 @ 表示 v-on: 和用 # 表示 v-slot:)

正例：
<input @input="onInput" @focus="onFocus" >

反例：
<input v-on:input="onInput" @focus="onFocus" >

2.1.4 标签顺序保持一致

单文件组件应该总是让标签顺序保持为

正例：
<template>...</template> <script> ... </script> <style> ... </style>

反例：
<template>...</template> <style>...</style> <script>...</script>

2.1.5 必须为 v-for 设置键值 key

2.1.6 v-show 与 v-if 选择

如果运行时，需要非常频繁地切换，使用 v-show ；如果在运行时，条件很少改变，使用 v-if。

2.1.7 script 标签内部结构顺序

components > props > data > computed > watch > filter > 钩子函数（钩子函数按其执行顺序） > methods

2.1.8 Vue Router 规范

1) 页面跳转数据传递使用路由参数

页面跳转，例如 A 页面跳转到 B 页面，需要将 A 页面的数据传递到 B 页面，推荐使用路由参数进行传参，而不是将需要传递的数据保存 vuex，然后在 B 页面取出 vuex 的数据，因为如果在 B 页面刷新会导致 vuex 数据丢失，导致 B 页面无法正常显示数据。

正例：
let id = ' 123'; this.$router.push({ name: 'userCenter', query: { id: id } });

2) 使用路由懒加载（延迟加载）机制

{ path: '/uploadAttachment', name: 'uploadAttachment', meta: { title: '上传附件' }, component: () => import('@/view/components/uploadAttachment/index.vue') },

3) router 中的命名规范

path、childrenPoints 命名规范采用 kebab-case 命名规范（尽量 Vue 文件的目录结构保持一致，因为目录、文件名都是 kebab-case，这样很方便找到对应的文件）

name 命名规范采用 KebabCase 命名规范且和 component 组件名保持一致！（因为要保持 keep-alive 特性，keep-alive 按照 component 的 name 进行缓存，所以两者必须高度保持一致）
`// 动态加载
export const reload = [
{
path: ‘/reload’,
name: ‘reload’,
component: Main,
meta: {
title: ‘动态加载’,
icon: ‘icon iconfont’
},

children: [<br />      {<br />        path: '/reload/smart-reload-list',<br />        name: 'SmartReloadList',<br />        meta: {<br />          title: 'SmartReload',<br />          childrenPoints: [<br />            {<br />              title: '查询',<br />              name: 'smart-reload-search'<br />            },<br />            {<br />              title: '执行reload',<br />              name: 'smart-reload-update'<br />            },<br />            {<br />              title: '查看执行结果',<br />              name: 'smart-reload-result'<br />            }<br />          ]<br />        },<br />        component: () =><br />          import('@/views/reload/smart-reload/smart-reload-list.vue')<br />      }<br />    ]<br />  }<br />];`

(二) Vue 项目目录规范

2.2.1 基础

vue 项目中的所有命名一定要与后端命名统一。
比如权限：后端 privilege, 前端无论 router , store, api 等都必须使用 privilege单词！

2.2.2 目录说明

目录名按照上面的命名规范，其中 components 组件用大写驼峰，其余除 components 组件目录外的所有目录均使用 kebab-case 命名。

1) api 目录

文件、变量命名要与后端保持一致。
此目录对应后端 API 接口，按照后端一个 controller 一个 api js 文件。若项目较大时，可以按照业务划分子目录，并与后端保持一致。
api 中的方法名字要与后端 api url 尽量保持语义高度一致性。
对于 api 中的每个方法要添加注释，注释与后端 swagger 文档保持一致。

正例：
后端 url： EmployeeController.java

/employee/add /employee/delete/{id} /employee/update

前端： employee.js

// 添加员工 addEmployee: (data) => { return postAxios('/employee/add', data) }, // 更新员工信息 updateEmployee: (data) => { return postAxios('/employee/update', data) }, // 删除员工 deleteEmployee: (employeeId) => { return postAxios('/employee/delete/' + employeeId) },

2) assets 目录

3) components 目录

4) constants 目录

此目录存放项目所有常量，如果常量在 vue 中使用，

目录结构：
|constants |-- index.js |-- role.js |-- employee.js

例子： employee.js
`export const EMPLOYEE_STATUS = {
NORMAL: {
value: 1,
desc: ‘正常’
},
DISABLED: {
value: 1,
desc: ‘禁用’
},
DELETED: {
value: 2,
desc: ‘已删除’
}
};

export const EMPLOYEE_ACCOUNT_TYPE = {
QQ: {
value: 1,
desc: ‘QQ登录’
},
WECHAT: {
value: 2,
desc: ‘微信登录’
},
DINGDING: {
value: 3,
desc: ‘钉钉登录’
},
USERNAME: {
value: 4,
desc: ‘用户名密码登录’
}
};

export default {
EMPLOYEE_STATUS,
EMPLOYEE_ACCOUNT_TYPE
};`

5) router 与 store 目录

这两个目录一定要将业务进行拆分，不能放到一个 js 文件里。
router 尽量按照 views 中的结构保持一致
store 按照业务进行拆分不同的 js 文件

2.2.3 注释说明

整理必须加注释的地方

公共组件使用说明
api 目录的接口 js 文件必须加注释
store 中的 state, mutation, action 等必须加注释
vue 文件中的 template 必须加注释，若文件较大添加 start end 注释
vue 文件的 methods，每个 method 必须添加注释
vue 文件的 data, 非常见单词要加注释
2.2.4 其他
1) 尽量不要手动操作 DOM
因使用 vue 框架，所以在项目开发中尽量使用 vue 的数据驱动更新 DOM，尽量（不到万不得已）不要手动操作 DOM，包括：增删改 dom 元素、以及更改样式、添加事件等。

2) 删除无用代码

因使用了 git/svn 等代码版本工具，对于无用代码必须及时删除，例如：一些调试的 console 语句、无用的弃用功能代码。

1.编程规范

一.命名规范

1.1.1 项目命名

1.1.2 目录命名

1.1.3 JS、CSS、SCSS、HTML、PNG 文件命名

1.1.4 命名严谨性

二. HTML 类型(vue template)

1.2.1 缩进

1.2.2 分块注释

1.2.3 语义化标签

1.2.4 引号

三.css规范

1.3.1 命名

1.3.1 选择器

1.3.2 尽量使用缩写属性

1.3.3 每个选择器及属性独占一行

1.3.4 省略0后面的单位

四. scss规范

1.4.1 代码组织

1) 将公共 less 文件放置在 style / less / common 文件夹

2) 按以下顺序组织

1.4.2 避免嵌套层级过多

五. Javascript 规范

1.5.1 命名

1) 采用小写驼峰命名 lowerCamelCase，代码中的命名均不能以下划线，也不能以下划线或美元符号结束

2) 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。

3) 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

1.5.2 代码格式

1) 使用 2 个空格进行缩进（一个tab）

2) 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。

1.5.3 字符串

1.5.4 对象声明

1) 使用字面值创建对象

2) 使用字面量来代替对象构造器

1.5.5 使用 ES6,ES7

1.5.6 括号

1.5.7 undefined 判断

1.5.8 条件判断和循环最多三层

1.5.9 this 的转换命名

1.5.10 慎用 console.log

二、Vue 项目规范

(一) Vue 编码基础

2.1.1. 组件规范

1) 组件名为多个单词。

2) 组件文件名为 pascal-case 格式

3) 基础组件文件名为 base 开头，使用完整单词而不是缩写。

5) 在 Template 模版中使用组件，应使用 PascalCase 模式，并且使用自闭合组件。 正例：

6) 组件的 data 必须是一个函数

7) Prop 定义应该尽量详细

8) 为组件样式设置作用域

9) 如果特性元素较多，应该主动换行。

2.1.2. 模板中使用简单的表达式

2.1.3 指令都使用缩写形式

2.1.4 标签顺序保持一致

2.1.5 必须为 v-for 设置键值 key

2.1.6 v-show 与 v-if 选择

2.1.7 script 标签内部结构顺序

2.1.8 Vue Router 规范

1) 页面跳转数据传递使用路由参数

2) 使用路由懒加载（延迟加载）机制

3) router 中的命名规范

(二) Vue 项目目录规范

2.2.1 基础

2.2.2 目录说明

1) api 目录

2) assets 目录

3) components 目录

4) constants 目录

5) router 与 store 目录

2.2.3 注释说明

2.2.4 其他

1) 尽量不要手动操作 DOM

2) 删除无用代码

5) 在 Template 模版中使用组件，应使用 PascalCase 模式，并且使用自闭合组件。
正例：