编码规范

本规范参考了 Google 前端代码规范和腾讯的前端团队规范文档,在此致谢。

Notes:我们在着手 Admui 开发之初,参考 Google 前端代码规范和腾讯的前端团队规范文档制定了这套规范,并尽量遵循使其代码保持美观一致的风格,为 Admui 的健康发展和团队协作奠定了基础,在此向他们致谢。但是Admui中包含的第三方代码(如 Bootstrap,jQuery,第三方插件库等)除外。我们推荐您也遵循或者部分遵循这套开发规范,以避免不必要的麻烦和提高开发效率。

命名规则

项目命名

全部采用小写方式, 以中划线分隔。如:my-project-name

目录命名

JS文件命名

参照项目命名规则。例:account-model.js

CSS, Sass文件命名

参照项目命名规则。例:retina-sprites.Sass

HTML文件命名

参照项目命名规则。例:error-report.html

HTML编码规范

语法

<!DOCTYPE html>
<html>
<head>
<title>Page title</title>
</head>
<body>
<img src="images/company_logo.png" alt="Company">

<h1 class="hello-world">Hello, world!</h1>
</body>
</html>

HTML5 doctype

<!DOCTYPE html>
<html>
...
</html>

lang属性

根据HTML5规范:

应在html标签上加上lang属性。这会给语音工具和翻译工具帮助,告诉它们应当怎么去发音和翻译。

<!DOCTYPE html>
<html lang="zh-cn">
...
</html>

字符编码

通过声明一个明确的字符编码,让浏览器轻松、快速的确定适合网页内容的渲染方式,通常指定为utf-8

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
</head>
...
</html>

IE兼容模式

<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
</head>
...
</html>

引入CSS, JS

根据HTML5规范, 通常在引入CSS和JS时不需要指明type,因为text/csstext/javascript分别是他们的默认值。

HTML5 规范链接

<!-- 外联 CSS -->
<link rel="stylesheet" href="code_guide.css">

<!-- 内嵌 CSS -->
<style>
...
</style>

<!-- 外联 JS -->
<script src="code_guide.js"></script>

<!-- 内嵌 JS -->
<script>
...
</script>

属性顺序

<a class="..." id="..." data-modal="toggle" href="#">Example link</a>

<input class="form-control" type="text">

<img src="..." alt="...">

boolean属性

<input type="text" disabled>
<input type="checkbox" value="1" checked>
<select>
<option value="1" selected>1</option>
</select>

JS生成标签

在JS文件中生成标签让内容变得更难查找,更难编辑,性能更差。应该尽量避免这种情况的出现。

减少标签数量

<!-- 不推荐写法 -->
<span class="avatar">
<img src="...">
</span>

<!-- 推荐写法 -->
<img class="avatar" src="...">

实用高于完美

CSS, Sass 编码规范

缩进

使用Tab缩进(4个空格)。

.element {
position: absolute;
top: 10px;
left: 10px;

border-radius: 10px;
width: 50px;
height: 50px;
}

分号

每个属性声明末尾都要加分号。

.element {
width: 20px;
height: 20px;

background-color: red;
}

空格

以下几种情况不需要空格:

以下几种情况需要空格:

/* 不推荐写法 */
.element {
color :red !important;
background-color: rgba(0,0,0,.5);
}

/* 推荐写法 */
.element {
color: red !important;
background-color: rgba(0, 0, 0, .5);
}

/* 不推荐写法 */
.element ,
.dialog{
...
}

/* 推荐写法 */
.element,
.dialog {

}

/* 不推荐写法 */
.element>.dialog{
...
}

/* 推荐写法 */
.element > .dialog{
...
}

/* 不推荐写法 */
.element{
...
}

/* 推荐写法 */
.element {
...
}

空行

以下几种情况需要空行:

/* 不推荐写法 */
.element {
...
}
.dialog {
color: red;
&:after {
...
}
}

/* 推荐写法 */
.element {
...
}

.dialog {
color: red;

&:after {
...
}
}

换行

以下几种情况不需要换行:

以下几种情况需要换行:

/* 不推荐写法 */
.element
{color: red; background-color: black;}

/* 推荐写法 */
.element {
color: red;
background-color: black;
}

/* 不推荐写法 */
.element, .dialog {
...
}

/* 推荐写法 */
.element,
.dialog {
...
}

注释

// Modal header
.modal-header {
...
}

// Modal header
// ------------------------------
.modal-header {
...
}

.modal-header {
// 50px
width: 50px;

color: red; // 红色
}

引号

.element:after {
content: "";
background-image: url("logo.png");
}

li[data-type="single"] {
...
}

命名

/* class */
.element-content {
...
}

/* id */
#myDialog {
...
}

/* 变量 */
$colorBlack: #000;

/* 函数 */
@function pxToRem($px) {
...
}

/* 混合 */
@mixin centerBlock {
...
}

属性声明顺序

相关的属性声明按右边的顺序做分组处理,组之间需要有一个空行。

.declaration-order {
display: block;
float: right;

position: absolute;
top: 0;
right: 0;
bottom: 0;
left: 0;
z-index: 100;

border: 1px solid #e5e5e5;
border-radius: 3px;
width: 100px;
height: 100px;

font: normal 13px "Helvetica Neue", sans-serif;
line-height: 1.5;
text-align: center;

color: #333;
background-color: #f5f5f5;

opacity: 1;
}

// 下面是推荐写法的属性的顺序
[
[
"display",
"visibility",
"float",
"clear",
"overflow",
"overflow-x",
"overflow-y",
"clip",
"zoom"
],
[
"table-layout",
"empty-cells",
"caption-side",
"border-spacing",
"border-collapse",
"list-style",
"list-style-position",
"list-style-type",
"list-style-image"
],
[
"-webkit-box-orient",
"-webkit-box-direction",
"-webkit-box-decoration-break",
"-webkit-box-pack",
"-webkit-box-align",
"-webkit-box-flex"
],
[
"position",
"top",
"right",
"bottom",
"left",
"z-index"
],
[
"margin",
"margin-top",
"margin-right",
"margin-bottom",
"margin-left",
"-webkit-box-sizing",
"-moz-box-sizing",
"box-sizing",
"border",
"border-width",
"border-style",
"border-color",
"border-top",
"border-top-width",
"border-top-style",
"border-top-color",
"border-right",
"border-right-width",
"border-right-style",
"border-right-color",
"border-bottom",
"border-bottom-width",
"border-bottom-style",
"border-bottom-color",
"border-left",
"border-left-width",
"border-left-style",
"border-left-color",
"-webkit-border-radius",
"-moz-border-radius",
"border-radius",
"-webkit-border-top-left-radius",
"-moz-border-radius-topleft",
"border-top-left-radius",
"-webkit-border-top-right-radius",
"-moz-border-radius-topright",
"border-top-right-radius",
"-webkit-border-bottom-right-radius",
"-moz-border-radius-bottomright",
"border-bottom-right-radius",
"-webkit-border-bottom-left-radius",
"-moz-border-radius-bottomleft",
"border-bottom-left-radius",
"-webkit-border-image",
"-moz-border-image",
"-o-border-image",
"border-image",
"-webkit-border-image-source",
"-moz-border-image-source",
"-o-border-image-source",
"border-image-source",
"-webkit-border-image-slice",
"-moz-border-image-slice",
"-o-border-image-slice",
"border-image-slice",
"-webkit-border-image-width",
"-moz-border-image-width",
"-o-border-image-width",
"border-image-width",
"-webkit-border-image-outset",
"-moz-border-image-outset",
"-o-border-image-outset",
"border-image-outset",
"-webkit-border-image-repeat",
"-moz-border-image-repeat",
"-o-border-image-repeat",
"border-image-repeat",
"padding",
"padding-top",
"padding-right",
"padding-bottom",
"padding-left",
"width",
"min-width",
"max-width",
"height",
"min-height",
"max-height"
],
[
"font",
"font-family",
"font-size",
"font-weight",
"font-style",
"font-variant",
"font-size-adjust",
"font-stretch",
"font-effect",
"font-emphasize",
"font-emphasize-position",
"font-emphasize-style",
"font-smooth",
"line-height",
"text-align",
"-webkit-text-align-last",
"-moz-text-align-last",
"-ms-text-align-last",
"text-align-last",
"vertical-align",
"white-space",
"text-decoration",
"text-emphasis",
"text-emphasis-color",
"text-emphasis-style",
"text-emphasis-position",
"text-indent",
"-ms-text-justify",
"text-justify",
"letter-spacing",
"word-spacing",
"-ms-writing-mode",
"text-outline",
"text-transform",
"text-wrap",
"-ms-text-overflow",
"text-overflow",
"text-overflow-ellipsis",
"text-overflow-mode",
"-ms-word-wrap",
"word-wrap",
"-ms-word-break",
"word-break"
],
[
"color",
"background",
"filter:progid:DXImageTransform.Microsoft.AlphaImageLoader",
"background-color",
"background-image",
"background-repeat",
"background-attachment",
"background-position",
"-ms-background-position-x",
"background-position-x",
"-ms-background-position-y",
"background-position-y",
"-webkit-background-clip",
"-moz-background-clip",
"background-clip",
"background-origin",
"-webkit-background-size",
"-moz-background-size",
"-o-background-size",
"background-size"
],
[
"outline",
"outline-width",
"outline-style",
"outline-color",
"outline-offset",
"opacity",
"filter:progid:DXImageTransform.Microsoft.Alpha(Opacity",
"-ms-filter:\\'progid:DXImageTransform.Microsoft.Alpha",
"-ms-interpolation-mode",
"-webkit-box-shadow",
"-moz-box-shadow",
"box-shadow",
"filter:progid:DXImageTransform.Microsoft.gradient",
"-ms-filter:\\'progid:DXImageTransform.Microsoft.gradient",
"text-shadow"
],
[
"-webkit-transition",
"-moz-transition",
"-ms-transition",
"-o-transition",
"transition",
"-webkit-transition-delay",
"-moz-transition-delay",
"-ms-transition-delay",
"-o-transition-delay",
"transition-delay",
"-webkit-transition-timing-function",
"-moz-transition-timing-function",
"-ms-transition-timing-function",
"-o-transition-timing-function",
"transition-timing-function",
"-webkit-transition-duration",
"-moz-transition-duration",
"-ms-transition-duration",
"-o-transition-duration",
"transition-duration",
"-webkit-transition-property",
"-moz-transition-property",
"-ms-transition-property",
"-o-transition-property",
"transition-property",
"-webkit-transform",
"-moz-transform",
"-ms-transform",
"-o-transform",
"transform",
"-webkit-transform-origin",
"-moz-transform-origin",
"-ms-transform-origin",
"-o-transform-origin",
"transform-origin",
"-webkit-animation",
"-moz-animation",
"-ms-animation",
"-o-animation",
"animation",
"-webkit-animation-name",
"-moz-animation-name",
"-ms-animation-name",
"-o-animation-name",
"animation-name",
"-webkit-animation-duration",
"-moz-animation-duration",
"-ms-animation-duration",
"-o-animation-duration",
"animation-duration",
"-webkit-animation-play-state",
"-moz-animation-play-state",
"-ms-animation-play-state",
"-o-animation-play-state",
"animation-play-state",
"-webkit-animation-timing-function",
"-moz-animation-timing-function",
"-ms-animation-timing-function",
"-o-animation-timing-function",
"animation-timing-function",
"-webkit-animation-delay",
"-moz-animation-delay",
"-ms-animation-delay",
"-o-animation-delay",
"animation-delay",
"-webkit-animation-iteration-count",
"-moz-animation-iteration-count",
"-ms-animation-iteration-count",
"-o-animation-iteration-count",
"animation-iteration-count",
"-webkit-animation-direction",
"-moz-animation-direction",
"-ms-animation-direction",
"-o-animation-direction",
"animation-direction"
],
[
"content",
"quotes",
"counter-reset",
"counter-increment",
"resize",
"cursor",
"-webkit-user-select",
"-moz-user-select",
"-ms-user-select",
"user-select",
"nav-index",
"nav-up",
"nav-right",
"nav-down",
"nav-left",
"-moz-tab-size",
"-o-tab-size",
"tab-size",
"-webkit-hyphens",
"-moz-hyphens",
"hyphens",
"pointer-events"
]
]

颜色

/* 不推荐写法 */
.element {
color: #ABCDEF;
background-color: #001122;
}

/* 推荐写法 */
.element {
color: #abcdef;
background-color: #012;
}

属性简写

常见的属性简写包括:

/* 不推荐写法 */
.element {
transition: opacity 1s linear 2s;
}

/* 推荐写法 */
.element {
transition-delay: 2s;
transition-timing-function: linear;
transition-duration: 1s;
transition-property: opacity;
}

媒体查询

尽量将媒体查询的规则靠近与他们相关的规则,不要将他们一起放到一个独立的样式文件中,或者丢在文档的最底部,这样做只会让大家以后更容易忘记他们。

.element {
...
}

.element-avatar{
...
}

@media (min-width: 480px) {
.element {
...
}

.element-avatar {
...
}
}

Sass相关

声明顺序:

  1. @import;
  2. 变量声明;
  3. 自身属性;
  4. 嵌套规则。
@import "dialog";

@default-text-color: #333;

.page {
width: 960px;
margin: 0 auto;
color: @default-text-color;
> .dialog {
...
}
}

杂项

/* 不推荐写法 */
.element {
}

/* 不推荐写法 */
LI {
...
}

/* 推荐写法 */
li {
...
}

/* 不推荐写法 */
.element {
color: rgba(0, 0, 0, 0.5);
}

/* 推荐写法 */
.element {
color: rgba(0, 0, 0, .5);
}

/* 不推荐写法 */
.element {
width: 50.0px;
}

/* 推荐写法 */
.element {
width: 50px;
}

/* 不推荐写法 */
.element {
width: 0px;
}

/* 推荐写法 */
.element {
width: 0;
}

/* 不推荐写法 */
.element {
border-radius: 3px;
-webkit-border-radius: 3px;
-moz-border-radius: 3px;

background: linear-gradient(to bottom, #fff 0, #eee 100%);
background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
background: -moz-linear-gradient(top, #fff 0, #eee 100%);
}

/* 推荐写法 */
.element {
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
border-radius: 3px;

background: -webkit-linear-gradient(top, #fff 0, #eee 100%);
background: -moz-linear-gradient(top, #fff 0, #eee 100%);
background: linear-gradient(to bottom, #fff 0, #eee 100%);
}

/* 不推荐写法 */
.element {
color: rgb(0, 0, 0);
width: 50px;
color: rgba(0, 0, 0, .5);
}

/* 推荐写法 */
.element {
color: rgb(0, 0, 0);
color: rgba(0, 0, 0, .5);
}

JavaScript编码规范

缩进

使用Tab缩进(4个空格)。

var x = 1,
y = 1;

if (x < y) {
x += 10;
} else {
x += 1;
}

单行长度

不要超过80,但如果编辑器开启word wrap可以不考虑单行长度。

分号

以下几种情况后需加分号:

/* 声明 */
var x = 1;

/* 表达式 */
x++;

/* do-while */
do {
x++;
} while (x < 10);

空格

以下几种情况不需要空格:

以下几种情况需要空格:

// 不推荐写法
var a = {
b :1
};

// 推荐写法
var a = {
b: 1
};

// 不推荐写法
++ x;
y ++;
z = x?1:2;

// 推荐写法
++x;
y++;
z = x ? 1 : 2;

// 不推荐写法
var a = [ 1, 2 ];

// 推荐写法
var a = [1, 2];

// 不推荐写法
var a = ( 1+2 )*3;

// 推荐写法
var a = (1 + 2) * 3;

// 在'('前不要有空格,在函数参数后的'{'留一个空格
var doSomething = function(a, b, c) {
// ……
};

// '('不留空格
doSomething(item);

// 不推荐写法
for(i=0;i<6;i++){
x++;
}

// 推荐写法
for (i = 0; i < 6; i++) {
x++;
}

空行

以下几种情况需要空行:

// 在声明变量之后留一空行
var x = 1;

// 当声明变量是当前语句块中最后一个表达式时,之后不需要留空行
if (x >= 1) {
var y = x + 1;
}

var a = 2;

// 在行注释之前需要留空行
a++;

function b() {
// 如果行注释是代码块中的第一行则注释之前不需要留空行
return a;
}

// 在代码块之后需要有空行
for (var i = 0; i < 2; i++) {
if (true) {
return false;
}

continue;
}

var obj = {
foo: function() {
return 1;
},

bar: function() {
return 2;
}
};

// 参数列表,数组,对象不需要留空行
func(
2,
function() {
a++;
},
3
);

var foo = [
2,
function() {
a++;
},
3
];


var foo = {
a: 2,
b: function() {
a++;
},
c: 3
};

换行

换行的地方,行末必须有’,’或者运算符;

以下几种情况不需要换行:

以下几种情况需要换行:

// 不推荐写法
var a = {
b: 1
, c: 2
};

x = y
? 1 : 2;

// 推荐写法
var a = {
b: 1,
c: 2
};

x = y ? 1 : 2;
x = y ?
1 : 2;

// 'else', 'catch', 'finally'不需要换行
if (condition) {
...
} else {
...
}

try {
...
} catch (e) {
...
} finally {
...
}

// 不推荐写法
function test()
{
...
}

// 推荐写法
function test() {
...
}

// 不推荐写法
var a, foo = 7, b,
c, bar = 8;

// 推荐写法
var a,
foo = 7,
b, c, bar = 8;

单行注释

if (condition) {
// 允许
allowed();
}

var zhangsan = 'zhangsan'; // 在代码之后加一个空格

多行注释

最少三行, ‘*’后跟一个空格,具体参照右边的写法;
建议在以下情况下使用:

/*
* 在'*'之后加一个空格
*/
var x = 1;

文档注释

各类标签@param, @method等请参考 usejsdocJSDoc Guide

建议在以下情况下使用:

/**
* @func
* @desc 一个带参数的函数
* @param {string} a - 参数a
* @param {number} b=1 - 参数b默认值为1
* @param {string} c=1 - 参数c有两种支持的取值</br>1—表示x</br>2—表示xx
* @param {object} d - 参数d为一个对象
* @param {string} d.e - 参数d的e属性
* @param {string} d.f - 参数d的f属性
* @param {object[]} g - 参数g为一个对象数组
* @param {string} g.h - 参数g数组中一项的h属性
* @param {string} g.i - 参数g数组中一项的i属性
* @param {string} [j] - 参数j是一个可选参数
*/
function foo(a, b, c, d, g, j) {
...
}

引号

最外层统一使用单引号。

// 不推荐写法
var x = "test";

// 推荐写法
var y = 'foo',
z = '<div id="test"></div>';

变量命名

var thisIsMyName;

var goodID;

var reportURL;

var AndroidVersion;

var iOSVersion;

var MAX_COUNT = 10;

function Person(name) {
this.name = name;
}

// 不推荐写法
var body = $('body');

// 推荐写法
var $body = $('body');

变量声明

一个函数作用域中所有的变量声明尽量提到函数首部,用一个var声明,不允许出现两个连续的var声明。

function doSomethingWithItems(items) {
// 只用一个'var'声明
var value = 10,
result = value + 10,
i,
len;

for (i = 0, len = items.length; i < len; i++) {
result += 10;
}
}

函数

无论是函数声明还是函数表达式,(前不要空格,但{前一定要有空格;

// 在'('之前不使用空格, 但在'{'之前要使用空格
var doSomething = function(item) {
// ……
};

function doSomething(item) {
// ……
}

// 不推荐写法
doSomething (item);

// 推荐写法
doSomething(item);

// 需要在立即调用的函数外面加括号
(function() {
return 1;
})();

// 不推荐写法
[1, 2].forEach(function x() {
...
});

// 推荐写法
[1, 2].forEach(function() {
...
});

// 不推荐写法
var a = [1, 2, function a() {
...
}];

// 推荐写法
var a = [1, 2, function() {
...
}];

// 在函数参数之间使用', ',有一个空格
var doSomething = function(a, b, c) {
// ……
};

数组、对象

// 不推荐写法
var a = {
'b': 1
};

var a = {b: 1};

var a = {
b: 1,
c: 2,
};

// 推荐写法
var a = {
b: 1,
c: 2
};

括号

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

// 不推荐写法
if (condition)
doSomething();

// 推荐写法
if (condition) {
doSomething();
}

null

适用场景:

不适用场景:

// 不推荐写法
function test(a, b) {
if (b === null) {
// not mean b is not supply
...
}
}

var a;

if (a === null) {
...
}

// 推荐写法
var a = null;

if (a === null) {
...
}

undefined

// 不推荐写法
if (person === undefined) {
...
}

// 推荐写法
if (typeof person === 'undefined') {
...
}

jshint

// 不推荐写法
if (a == 1) {
a++;
}

// 推荐写法
if (a === 1) {
a++;
}

// 推荐写法
for (key in obj) {
if (obj.hasOwnProperty(key)) {
// 确保obj[key]是对象,且不会被继承
console.log(obj[key]);
}
}

// 不推荐写法
Array.prototype.count = function(value) {
return 4;
};

// 不推荐写法
var x = 1;

function test() {
if (true) {
var x = 0;
}

x += 1;
}

// 不推荐写法
function test() {
console.log(x);

var x = 1;
}

// 不推荐写法
new Person();

// 推荐写法
var person = new Person();

// 不推荐写法
delete(obj.attr);

// 推荐写法
delete obj.attr;

// 不推荐写法
if (a = 10) {
a++;
}

// 不推荐写法
var a = [1, , , 2, 3];

// 不推荐写法
var nums = [];

for (var i = 0; i < 10; i++) {
(function(i) {
nums[i] = function(j) {
return i + j;
};
}(i));
}

// 不推荐写法
var singleton = new function() {
var privateVar;

this.publicMethod = function() {
privateVar = 1;
};

this.publicMethod2 = function() {
privateVar = 2;
};
};

杂项

// 不推荐写法
var a = 1;

function Person() {
// 不推荐写法
var me = this;

// 推荐写法
var _this = this;

// 推荐写法
var that = this;

// 推荐写法
var self = this;
}

// 推荐写法
switch (condition) {
case 1:
case 2:
// ……
break;
case 3:
// ……
// 通过
case 4
...
break;
// 没有默认
}

// 不允许有空的代码块
if (condition) {

}