前端规范
1、命名规范
1.1 目录命名
全部采用小写方式， 以中划线分隔，有复数结构时，要采用复数命名法， 缩写不用复数。
例： scripts/styles/components/images
【特殊】：vue components 中组件中使用 kebab-case 或 pascal。
例： TimePicker 或 time-picker
1.2 JS、CSS、HTML、PNG文件命名
采用小写方式， 以中划线分隔.
例： assets/images/login-bg.png
1.3 命名严谨性
代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的 英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用
2、HTML规范(Vue Template同适用)
2.1 HTML类型
推荐使用 HTML5 的文档类型申明：
（建议使用 text/html 格式的 HTML。避免使用 XHTML。XHTML 以及它的属性，比如 application/xhtml+xml 在浏览器中的应用支持与优化空间都十分有限）。
规定字符编码
IE 兼容模式
规定字符编码
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta charset="UTF-8" />
<title>Page title</title>
</head>
<body>
<img src="images/company-logo.png" alt="Company">
</body>
</html>
2.2 分块注释
在每一个块状元素，列表元素和表格元素后，加上一对 HTML 注释。
2.3 标签语义化
HTML5 中新增很多语义化标签，所以优先使用语义化标签，避免一个页面都是 div 或者 p 标 签。
例：
<header></header>
<footer></footer>
2.4 缩进
缩进使用2个空格(一个tab)
3 CSS规范
3.1 命名
必须由英文字母、数字或“-”下划线组成，必须以字母开头，不能为纯数字。设计者要用有意义的单词或缩写组合来命名选择符
id采用驼峰命名
scss中的变量、函数、混合采用驼峰命名
3.2 选择器
3.2.1 css选择器中避免使用标签名
避免css中出现HTML标签，并且在css选择器中出现标签名会存在潜在的问题。
3.2.2 使用直接子选择器
如果不写很通用的，需要匹配到DOM末端的选择器，考虑直接选择器
no：
.box .content {
font-size: 18px;
}
yes：
.box > .content {
font-size: 18px;
}
3.3 尽量使用缩写属性
no：
padding-left: 15px;
font-family: serif;
font-size: 18px;
line-height: 1.6;
yes：
padding: 0 10px 15px 20px;
font: 18px/1.6 serif;
3.4 每个选择器及属性独占一行
no：
.box{
width: 100%; height: 80%;
}
yes：
.box {
width: 100%;
height: 80%;
}
3.5 省略0后面的单位
no：
.box {
padding: 0px;
}
yes：
.box {
padding: 0;
}
3.6 避免使用ID选择器及全部标签选择器，防止污染全局样式
no：
#header {
margin: 0;
}
yes：
.header {
margin: 0;
}
4、SASS规范
4.1 编码
使用UTF-8编码，每个SASS文件的第一行必须是定义编码的@charset "UTF-8";如果没定义编码，很有可能会出现跨平台兼容问题。
4.2 代码组织
2.变量声明;
1.@import;
3.样式声明;
$base-font-size: 12px !default;
@import "base/config";
@import "biz/page";
body {
background: #fff;
}
4.3 @import语句
同一个SASS文件中所有的@import必须放在用一块，不得分开；
建议使用双引号引入SASS文件，至少同一个项目要保持一致；
4.4 变量
变量名必须采用小写字母，以中划线分割形式，不得使用驼峰
no：
$cardColor: #fff;
yes：
$card-color: #fff;
4.5继承
使用继承时，如果在声明块内书写@extend语句，必须在开头
no：
.box {
color: #fff;
@extend sameStyle;
}
yes：
.box {
@extend sameStyle;
color: #fff;
}
4.6 避免嵌套过多层
将签到深度限制在3级。避免大量的嵌套规则。当可读性收到影响时
4.7 BEM命名
SASS内使用BEM命名时，请勿使用缩写与嵌套；
SASS BEM使用缩写会不利于名称搜索、排查定位；另外，BEM本来就是为了解决嵌套问题，因此没必要多此一举。
no：
.box {
color: #fff;
$__item {
width: 100%;
}
}
yes：
.box {
color: #fff;
}
.box__item {
width: 100%;
}
5、JavaScript规范
5.1命名
5.1.1 采用小写驼峰命名 lowerCamelCase，代码中的命名均不能以下划线， 也不能以下划线或美元符号结束
5.1.2 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风 格，必须遵从驼峰形式；method 方法命名必须是 动词 或者 动词+名词 形式
增删改查：add / update / delete / detail / get
其他常用单词：
附： 函数方法常用的动词:
get 获取/set 设置,
add 增加/remove 删除,
create 创建/destory 销毁,
start 启动/stop 停止,
open 打开/close 关闭,
read 读取/write 写入,
load 载入/save 保存,
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 折叠,
enter 进入/exit 退出,
abort 放弃/quit 离开,
obsolete 废弃/depreciate 废旧,
collect 收集/aggregate 聚集
5.1.3 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚， 不要嫌名字长
5.2 代码格式
5.2.1 使用 2 个空格进行缩进
5.2.2 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以 提升可读性
5.3 对象声明
5.3.1 使用字面值创建对象 let user = {};
5.3.2 使用字面量来代替对象构造器 var user = { age: 0, name: 1, city: 3 };
5.5 使用 ES6+
必须优先使用 ES6+ 中新增的语法糖和函数。这将简化你的程序，并让你的代码更加灵活和可复 用。比如箭头函数、await/async ， 解构， let ， for…of 等等。
5.6括号
下列关键字后必须有大括号（即使代码块的内容只有一行）：if, else, for, while, do, switch, try,catch, finally, with。
5.7 undefined 判断
永远不要直接使用 undefined 进行变量判断；使用 typeof 和字符串’undefined’对变量进行判断。if (typeof person === 'undefined') { ... }
5.8 条件判断和循环最多三层
条件判断能使用三目运算符和逻辑运算符解决的，就不要使用条件判断，但是谨记不要写太长的 三目运算符。如果超过 3 层请抽成函数，并写清楚注释。
5.9 this 的转换命名
对上下文 this 的引用只能使用 ’self’ 来命名。
6 Vue项目规范
6.1 Vue编码基础
vue 项目规范以 Vue 官方规范 中的 A 规范为基础，在其上面进行项目开发，故所有代码均遵守该规范。
请仔仔细细阅读 Vue 官方规范，切记，此为第一步。
6.2 组件规范
6.2.1 组件名为多个单词。
组件名应该始终是多个单词组成（大于等于 2），且命名规范为KebabCase格式。
这样做可以避免跟现有的以及未来的 HTML 元素相冲突，因为所有的 HTML 元素名称都是单个单词的。
6.2.2 组件文件名为 pascal-case 格式
components/
|- my-component.vue
6.2.3 基础组件文件名为 base 开头，使用完整单词而不是缩写。
components/
|- base-button.vue
|- base-table.vue
|- base-icon.vue
6.2.4 和父组件紧密耦合的子组件应该以父组件名作为前缀命名
components/
|- todo-list.vue
|- todo-list-item.vue
|- todo-list-item-button.vue
|- user-profile-options.vue （完整单词）
6.2.5 在 Template 模版中使用组件，应使用 PascalCase 模式，并且使用自闭合组件。
<!-- 在单文件组件、字符串模板和 JSX 中 -->
<MyComponent />
<Row><table :column="data"/></Row>
6.2.5 组件的 data 必须是一个函数
当在组件中使用 data 属性的时候 (除了 new Vue 外的任何地方)，它的值必须是返回一个对象的函数。因为如果直接是一个对象的话，子组件之间的属性值会互相影响。
6.2.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
}
}
6.2.8 为组件样式设置作用域
使用 scoped 设置作用域
6.3.1 模板中使用简单的表达式
组件模板应该只包含简单的表达式，复杂的表达式则应该重构为计算属性或方法。复杂表达式会让你的模板变得不那么声明式。我们应该尽量描述应该出现的是什么，而非如何计算那个值。而且计算属性和方法使得代码可以重用。
6.3.2 指令都使用缩写形式
指令推荐都使用缩写形式，(用 : 表示 v-bind: 、用 @ 表示 v-on: 和用 # 表示 v-slot:)
6.3.3 标签顺序保持一致
<template>...</template>
<script>...</script>
<style>...</style>
6.3.5 必须为 v-for 设置键值 key
6.3.6 v-show 与 v-if 选择
如果运行时，需要非常频繁地切换，使用 v-show ；如果在运行时，条件很少改变，使用 v-if。
6.3.7 script 标签内部结构顺序
components > props > data > computed > watch > filter > 钩子函数（钩子函数按其执行顺序） > methods
6.4 Vue Router 规范
6.4.1 页面跳转数据传递使用路由参数
页面跳转，例如 A 页面跳转到 B 页面，需要将 A 页面的数据传递到 B 页面，推荐使用 路由参数进行传参，而不是将需要传递的数据保存 vuex，然后在 B 页面取出 vuex 的数据，因为如果在 B 页面刷新会导致 vuex 数据丢失，导致 B 页面无法正常显示数据。
6.4.2 使用路由懒加载（延迟加载）机制
{
path: '/upload-attachment',
name: 'upload-attachment',
meta: {
title: '上传附件'
},
component: () => import('@/view/components/uploadAttachment/index.vue')
},
6.4.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: [
{
path: '/reload/smart-reload-list',
name: 'SmartReloadList',
meta: {
title: 'SmartReload',
childrenPoints: [
{
title: '查询',
name: 'smart-reload-search'
},
{
title: '执行reload',
name: 'smart-reload-update'
},
{
title: '查看执行结果',
name: 'smart-reload-result'
}
]
},
component: () =>
import('@/views/reload/smart-reload/smart-reload-list.vue')
}
]
}
];
6.4.4 router 中的 path 命名规范
path除了采用kebab-case命名规范以外，必须以 / 开头，即使是children里的path也要以 / 开头。如下示例
经常有这样的场景：某个页面有问题，要立刻找到这个vue文件，如果不用以/开头，path为parent和children组成的，可能经常需要在router文件里搜索多次才能找到，而如果以/开头，则能立刻搜索到对应的组件
{
path: '/file',
name: 'File',
component: Main,
meta: {
title: '文件服务',
icon: 'ios-cloud-upload'
},
children: [
{
path: '/file/file-list',
name: 'FileList',
component: () => import('@/views/file/file-list.vue')
},
{
path: '/file/file-add',
name: 'FileAdd',
component: () => import('@/views/file/file-add.vue')
},
{
path: '/file/file-update',
name: 'FileUpdate',
component: () => import('@/views/file/file-update.vue')
}
]
}
6.5 Vue 项目目录规范
6.5.1 基础
vue 项目中的所有命名一定要与后端命名统一。
比如权限：后端 privilege, 前端无论 router , store, api 等都必须使用 privielege 单词！
6.5.2 使用 Vue-cli 脚手架
使用 vue-cli3 来初始化项目，项目名按照上面的命名规范。
6.5.3 目录说明
目录名按照上面的命名规范，其中 components 组件用大写驼峰，其余除 components 组件目录外的所有目录均使用 kebab-case 命名。
src 源码目录
|-- api 所有api接口
|-- assets 静态资源，images, icons, styles等
|-- components 公用组件
|-- config 配置信息
|-- constants 常量信息，项目所有Enum, 全局常量等
|-- directives 自定义指令
|-- filters 过滤器，全局工具
|-- datas 模拟数据，临时存放
|-- lib 外部引用的插件存放及修改文件
|-- mock 模拟接口，临时存放
|-- plugins 插件，全局使用
|-- router 路由，统一管理
|-- store vuex, 统一管理
|-- themes 自定义样式主题
|-- views 视图目录
| |-- role role模块名
| |-- |-- role-list.vue role列表页面
| |-- |-- role-add.vue role新建页面
| |-- |-- role-update.vue role更新页面
| |-- |-- index.less role模块样式
| |-- |-- components role模块通用组件文件夹
| |-- employee employee模块
6.5.4 api 目录
- 文件、变量命名要与后端保持一致。
- 此目录对应后端 API 接口，按照后端一个 controller 一个 api js 文件。若项目较大时，可以- 按照业务划分子目录，并与后端保持一致。
- api 中的方法名字要与后端 api url 尽量保持语义高度一致性。
- 对于 api 中的每个方法要添加注释，注释与后端 swagger 文档保持一致。
网友评论