前端代码规范
- 规范的目的是为了编写高质量的代码，让你的团队成员每天得心情都是愉悦的，大家在一起是快
乐的。 - 引自《阿里规约》的开头片段：
----现代软件架构的复杂性需要协同开发完成，如何高效地协同呢？无规矩不成方圆，无规范难
以协同，比如，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全，试想如果
没有限速，没有红绿灯，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是消灭代码内容
的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率，
降低沟通成本。代码的字里行间流淌的是软件系统的血液，质量的提升是尽可能少踩坑，杜绝踩
重复的坑，切实提升系统稳定性，码出质量。
命名规范
- 项目命名
全部采用小写方式，以中线分隔。
正例：mall-management-system
反例：mall_management-system / mallManagementSystem
- 目录命名
全部采用小写方式， 以中划线分隔，有复数结构时，要采用复数命名法， 缩写不用复数。
正例： 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
- JS、CSS、SCSS、HTML、PNG 文件命名
全部采用小写方式， 以中划线分隔。
正例： render-dom.js / signup.css / index.html / company-logo.png
反例： renderDom.js / UserManagement.html
- 命名严谨性
代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。 说明：正确的
英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用
正例：henan / luoyang / rmb 等国际通用的名称，可视同英文
反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3
杜绝完全不规范的缩写，避免望文不知义：
反例：AbstractClass “缩写”命名成 AbsClass；condition “缩写”命名成 condi，此类随意缩写严重
降低了代码的可阅读性。
HTML 规范 （Vue Template 同样适用）
- HTML 类型
推荐使用 HTML5 的文档类型申明：
（建议使用 text/html 格式的 HTML。避免使用 XHTML。XHTML 以及它的属性，比如
application/xhtml+xml 在浏览器中的应用支持与优化空间都十分有限）。
规定字符编码
IE 兼容模式
规定字符编码
doctype 大写
正例：
<!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 个空格（一个 tab）；
嵌套的节点应该缩进。
- 分块注释
在每一个块状元素，列表元素和表格元素前，加上一对 HTML 注释。
- 语义化标签
HTML5 中新增很多语义化标签，所以优先使用语义化标签，避免一个页面都是 div 或者 p 标
签。
正例
<header></header>
<footer></footer>
反例
<div>
<p></p>
</div>
- 引号
使用双引号(" ") 而不是单引号(’ ') 。
正例：<div class=”box”></div>
反例：<div class=’box’></div>
CSS 规范
- 命名
# 类名使用小写字母，以中划线分隔
# id 采用驼峰式命名
# scss 中的变量、函数、混合、placeholder 采用驼峰式命名
- css 选择器中避免使用标签名
从结构、表现、行为分离的原则来看，应该尽量避免 css 中出现 HTML 标签，并且在 css 选择
器中出现标签名会存在潜在的问题。
- 使用直接子选择器
很多前端开发人员写选择器链的时候不使用 直接子选择器（注：直接子选择器和后代选择器的区别）。有时，这可能会导致疼痛的设计问题并且有时候可能会很耗性能。
然而，在任何情况下，这是一个非常不好的做法。如果你不写很通用的，需要匹配到 DOM 末端的选择器， 你应该总是考虑直接子选择器。
# 不推荐:
.content .title {
font-size: 2rem;
}
# 推荐:
.content > .title {
font-size: 2rem;
}
- 尽量使用缩写属性
# 不推荐：
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;
- 省略 0 后面的单位
# 不推荐：
div {
padding-bottom: 0px;
margin: 0em;
}
# 推荐：
div {
padding-bottom: 0;
margin: 0;
}
- 避免使用 ID 选择器及全局标签选择器防止污染全局样式
# 不推荐：
#header {
padding-bottom: 0px;
margin: 0em;
}
# 推荐：
.header {
padding-bottom: 0px;
margin: 0em;
}
Javascript 规范
- 命名
# 采用小写驼峰命名 lowerCamelCase，代码中的命名均不能以下划线，也不能以下划线或美元符号结束
反例： _name / name_ / name$
# 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式
正例： localValue / getHttpMessage() / inputUserId*其中 method 方法命名必须是 动词 或者 动词+名词 形式*
正例：saveShopCarData /openShopCarInfoDialog
反例：save
# 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长
正例： MAX_STOCK_COUNT
反例： MAX_COUNT
- 统一单词汇
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 注入/provide提取,
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 解码,
encryption加密/decryption解密,
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 聚集
- 不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以
提升可读性
说明：任何情形，没有必要插入多个空行进行隔开。 - 字符串
- 这在创建 HTML 字符串非常有好处
单个字符串使用单引号，不使用双引号,这在创建 HTML 字符串非常有好处：
拼接字符串统一使用ES6字符串模板(``)，不使用双引号或单引号 “+”拼接。
正例:
let str = 'foo';
let testDiv = `<div id="test">${str}</div>`;
反例:
let str = 'foo';
let testDiv = '<div id="test">' + str + '</div>';
- 对象声明
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;
- 使用 ES6+
必须优先使用 ES6+ 中新增的语法糖和函数。这将简化你的程序，并让你的代码更加灵活和可复
用。比如箭头函数、await/async ， 解构， let ， for…of 等等。
- 括号
下列关键字后必须有大括号（即使代码块的内容只有一行）：if, else, for, while, do, switch, try, catch, finally, with。
正例：
if (condition) {
doSomething();
}
反例：
if (condition) doSomething();
- undefined 判断
永远不要直接使用 undefined 进行变量判断；使用 typeof 和字符串’undefined’对变量进行判断。
正例：
if (typeof person === 'undefined') {
... }
反例：
if (person === undefined) {
... }
- 条件判断和循环最多三层
条件判断能使用三目运算符和逻辑运算符解决的，就不要使用条件判断，但是谨记不要写太长的
三目运算符。如果超过 3 层请抽成函数，并写清楚注释。
- this 的转换命名
对上下文 this 的引用只能使用 ’_self’
慎用 console.log
因 console.log 大量使用会有性能问题，所以在非 webpack 项目中谨慎使用 log 功能。
调试完毕后记得销毁
- 滥用变量
var kpi = 4; // 定义好了之后再也没用过
var a = 1;
var b = 2;
var c = a+b;
// 没用的就删除掉，不然过三个月自己都不敢删，怕是不是那用到了
- 变量的命名
反例：
let fName = 'jackie'; // 自我感觉良好的缩写
let lName = 'willen'; // 这个问题和上面的一样
正例：
let firstName = 'jackie'; // 怎么样，是不是一目了然。少被喷了一次
let lastName = 'willen';
// 无需对每个变量都写注释，从名字上就看懂,(特殊的除外)
- 特定的变量
反例:
if (value.length < 8) { // 为什么要小于8，8表示啥？长度，还是位移，还是高度？Oh,my God!!
....
}
正例:
const MAX_INPUT_LENGTH = 8;
if (value.length < MAX_INPUT_LENGTH) { // 一目了然，不能超过最大输入长度
....
}
扫一扫
110
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
