前端代码规范文本

前端代码规范

代码目录结构my_project_name 项目名
+– css/ –css文件目录
| — ui_anim.css
| — ui_base.css
+– js/ –js文件目录
| — appcan.js
| — appcan.min.js
+– images/ –图片文件目录
+– html/ –页面目录(如果项目功能过多，可以按功能分目录，页面放到对应的目录下，例如：home模块)
| +— home/
| | — home.html
| | — home_content.html
— index.html
— index_content.html

一般命名规范

项目命名
全部采用小写字母，以中划线分割单词，每个单词要有意义。
例如：my_project_name

目录命名
参照项目命名规则；
有复数结构时，要采用复数命名法。
例：scripts, styles, images, data_models

JS文件命名
参照项目命名规则。
例：account_model.js

CSS文件命名
参照项目命名规则。
例：retina_sprites.css

HTML文件命名
参照项目命名规则。
例：error_report.html
注：由于appcan页面结构是分为主页面和浮动页面，浮动页面命名是以“_content”结尾。例：error_report_content.html

HTML

语法•缩进使用tab键（4个空格）;
•嵌套的节点应该缩进;
•在属性上，使用双引号，不要使用单引号;
•属性名全小写，用中划线做分隔符；例如：class=”modal-header”
•不要在自动闭合标签结尾处使用斜线(HTML5规范 指出他们是可选的）;
•不要忽略可选的关闭标签，例 和

字符编码
通过声明一个明确的字符编码，让浏览器轻松、快速的确定适合网页内容的渲染方式，通常指定为’UTF-8’，不区分大小写。
例：

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

…

...

属性顺序
属性应该按照特定的顺序出现以保证易读性；
- id
- class
- name
- data-
- src,for,type,href,value,max-length,max,min,pattern
- placeholder,title,alt
- aria-,role
- required,readonly,disabled
-
id更加具体且整个页面是唯一，将它放在第一位;
class是为高可复用组件设计的，应处在二位;
Example link

boolean属性
boolean属性指不需要声明取值的属性，XHTML需要每个属性声明取值，但是HTML5并不需要;
boolean属性的存在表示取值为true，不存在则表示取值为false。

1

以下是appcan页面的结构
下面是主页面(test.html)的结构，浮动页面会在id=”test_content”中显示，新建页面情况下这个id的值是content，因此要把这个值修改为主页面的名字加上”_content”，如：test_content,包括下面初始化js代码中的值也是需要修改。
修改的原因：多页面操作时浮动页面的名字都是content，操作方法和数据会出现混乱，不知道操作是哪个主页面的浮动页面

appcan.ready(function() {
var titHeight = $('#header').offset().height;
appcan.frame.open("test_content", "test_content.html", 0, titHeight);
window.onorientationchange = window.onresize = function() {
appcan.frame.resize("test_content", 0, titHeight);
}
});

CSS

缩进,分号
使用tab键（4个空格缩进），每个属性声明末尾都要加分号。
.element {
position: absolute;
top: 10px;
left: 10px;
border-radius: 10px;
width: 50px;
height: 50px;
}

空格
以下几种情况不需要空格：
- 属性名后
- 多个规则的分隔符’,’前
- !important ‘!’后
- 属性值中’(‘后和’)’前
- 行末不要有多余的空格

以下几种情况需要空格：
- 属性值前 选择器’>’, ‘+’, ‘~’前后
- ‘{‘前 !important ‘!’前
- 属性值中的’,’后
- 注释’/‘后和’/‘前
/* 不推荐 */
.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 {
…
}

颜色
颜色16进制用小写字母,尽量用简写。
/* 不推荐 */
.element {
color: #ABCDEF;
background-color: #001122;
}
/* 推荐 */
.element {
color: #abcdef;
background-color: #012;
}

JavaScript

缩进
使用tab键（4个空格缩进）

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

分号
以下几种情况后需加分号：
•变量声明
•表达式
•return
•throw
•break
•continue
•do-while
/* var declaration */
var x = 1;
/* expression statement */
x++;
/* do-while */
do {
x++;
} while (x < 10);

空格
以下几种情况不需要空格：
•对象的属性名后
•前缀一元运算符后
•后缀一元运算符前
•函数调用括号前
•无论是函数声明还是函数表达式，’(‘前不要空格
•数组的’[‘后和’]’前
•对象的’{‘后和’}’前
•运算符’(‘后和’)’前
•以下几种情况需要空格：
•二元运算符前后
•三元运算符’?:’前后
•代码块’{‘前
•下列关键字前：else, while, catch, finally
•下列关键字后：if, else, for, while, do, switch, case, try, catch, finally, with, return, typeof
•单行注释’//‘后（若单行注释和代码同行，则’//‘前也需要），多行注释’*’后
•对象的属性值前
•for循环，分号后留有一个空格，前置条件如果有多个，逗号后留一个空格
•无论是函数声明还是函数表达式，’{‘前一定要有空格
•函数的参数之间
// 不推荐
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;
// no space before ‘(‘, one space before ‘{‘, one space between function parameters
var doSomething = function(a, b, c) {
// do something
};
// 在 ‘(‘前不要有空格
doSomething(item);
// 不推荐
for(i=0;i<6;i++){
x++;
}
// 推荐
for (i = 0; i < 6; i++) {
x++;
}

空行
以下几种情况需要空行：
•变量声明后（当变量声明在代码块的最后一行时，则无需空行）
•注释前（当注释在代码块的第一行时，则无需空行）
•代码块后（在函数调用、数组、对象中则无需空行）
•文件最后保留一个空行

// need blank line after variable declaration
var x = 1;
// not need blank line when variable declaration is last expression in the current block
if (x >= 1) {
var y = x + 1;
}
var a = 2;
// need blank line before line comment
a++;
function b() {
// not need blank line when comment is first line of block
return a;
}
// need blank line after blocks
for (var i = 0; i < 2; i++) {
if (true) {
return false;
}
continue;
}
var obj = {
foo: function() {
return 1;
},
bar: function() {
return 2;
}
};
// not need blank line when in argument list, array, object
func(
2,
function() {
a++;
},
3
);
var foo = [
2,
function() {
a++;
},
3
];
var foo = {
a: 2,
b: function() {
a++;
},
c: 3
};

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

以下几种情况不需要换行：
•下列关键字后：else, catch, finally
•代码块’{‘前

以下几种情况需要换行：
- 代码块’{‘后和’}’前
- 变量赋值后

// 不推荐
var a = {
b: 1
, c: 2
};
x = y
? 1 : 2;
// 推荐
var a = {
b: 1,
c: 2
};
x = y ? 1 : 2;
x = y ?
1 : 2;
// no need line break with ‘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) {
// if you made it here, then all security checks passed
allowed();
}
var zhangsan = ‘zhangsan’; // one space after code

多行注释
最少三行, ‘*’后跟一个空格，具体参照下边的写法；
建议在以下情况下使用：
•难于理解的代码段
•可能存在错误的代码段
•浏览器特殊的HACK代码
•业务逻辑强相关的代码
/*
* one space after ‘*’
*/
var x = 1;

文档注释
各类标签@param, @method等请参考usejsdoc和JSDoc Guide；
建议在以下情况下使用：
•所有常量
•所有函数
•所有类
/**
* @func
* @desc 一个带参数的函数
* @param {string} a - 参数a
* @param {number} b=1 - 参数b默认值为1
* @param {string} c=1 - 参数c有两种支持的取值1—表示x2—表示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 = ‘

‘;

变量命名

标准变量采用驼峰式命名
ID 在变量名中全大写
URL 在变量名中全大写
Android 在变量名中大写第一个字母
iOS 在变量名中小写第一个，大写后两个字母
常量全大写，用下划线连接
构造函数，大写第一个字母
jquery 对象必须以 开头命名varthisIsMyName;vargoodID;varreportURL;varAndroidVersion;variOSVersion;varMAXCOUNT=10;functionPerson(name)this.name=name;//不推荐varbody= (‘body’);
// 推荐
var body= (‘body’);

前缀规范s：表示字符串。例如：sName，sHtml;
n：表示数字。例如：nPage，nTotal;
b：表示逻辑。例如：bChecked，bHasLogin;
a：表示数组。例如：aList，aGroup;
r：表示正则表达式。例如：rDomain，rEmail;
f：表示函数。例如：fGetHtml，fInit;
o：表示以上未涉及到的其他对象，例如：oButton，oDate;

变量声明
一个函数作用域中所有的变量声明尽量提到函数首部，用一个var声明，不允许出现两个连续的var声明。
function doSomethingWithItems(items) {
// use one var
var value = 10,
result = value + 10,
i,
len;
for (i = 0, len = items.length; i < len; i++) {
result += 10;
}
}

函数
无论是函数声明还是函数表达式，’(‘前不要空格，但’{‘前一定要有空格；
函数调用括号前不需要空格；
立即执行函数外必须包一层括号；
不要给inline function命名；
参数之间用’, ‘分隔，注意逗号后有一个空格。
// no space before ‘(‘, but one space before’{’
var doSomething = function(item) {
// do something
};
function doSomething(item) {
// do something
}
// 不推荐
doSomething (item);
// good
doSomething(item);
// requires parentheses around immediately invoked function expressions
(function() {
return 1;
})();
// 不推荐
[1, 2].forEach(function x() {
…
});
// 推荐
[1, 2].forEach(function() {
…
});
// 不推荐
var a = [1, 2, function a() {
…
}];
// 推荐
var a = [1, 2, function() {
…
}];
// use ‘, ’ between function parameters
var doSomething = function(a, b, c) {
// do something
};

数组、对象
对象属性名不需要加引号；
对象以缩进的形式书写，不要写在一行；
数组、对象最后不要有逗号。
// 不推荐
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
适用场景：
•初始化一个将来可能被赋值为对象的变量
•与已经初始化的变量做比较
•作为一个参数为对象的函数的调用传参
•作为一个返回对象的函数的返回值
•不适用场景：
•不要用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
永远不要直接使用undefined进行变量判断；
使用typeof和字符串’undefined’对变量进行判断。
// 不推荐
if (person === undefined) {
…
}
// 推荐
if (typeof person === ‘undefined’) {
…
}

js检测•用’===’, ‘!==’代替’==’, ‘!=’；
•for-in里一定要有hasOwnProperty的判断；
•不要在内置对象的原型上添加方法，如Array, Date；
•不要在内层作用域的代码里声明了变量，之后却访问到了外层作用域的同名变量；
•变量不要先使用后声明；
•不要在一句代码中单单使用构造函数，记得将其赋值给某个变量；
•不要在同个作用域下声明同名变量；
•不要在一些不需要的地方加括号，例：delete(a.b)；
•不要使用未声明的变量（全局变量需要加到.jshintrc文件的globals属性里面）；
•不要声明了变量却不使用；
•不要在应该做比较的地方做赋值；
•debugger不要出现在提交的代码里；
•数组中不要存在空元素；
•不要在循环内部声明函数；
•不要像这样使用构造函数，例：new function () { … }, new Object；
// 不推荐
if (a == 1) {
a++;
}
// 推荐
if (a === 1) {
a++;
}
// 推荐
for (key in obj) {
if (obj.hasOwnProperty(key)) {
// be sure that obj[key] belongs to the object and was not inherited
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;
};
};

其他注意事项
不要混用tab和space；
不要在一处使用多个tab或space；
换行符统一用’LF’；
对上下文this的引用只能使用’_this’, ‘that’, ‘self’其中一个来命名；
行尾不要有空白字符；
switch的falling through和no default的情况一定要有注释特别说明；
不允许有空的代码块。

// 不推荐
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:
…
// why fall through
case 4
…
break;
// why no default
}
// 不推荐空代码块存在
if (condition) {
}