前端开发规范.md

Bluefocus

前端团队开发规范

---

［postcss 规范］

• (1) 页面中所有用到的全局颜色，请到变量中

［文件夹命名 规范］

• (1) 文件夹命名必须全部小写，查找英文代替，搜索不到的可以用中文拼音代替

［文件命名 规范］

• (2) 文件夹命名必须全部小写，查找英文代替，搜索不到的可以用中文拼音代替

［css 规范］

• (1) 注释规范

文件注释
/*
* @description: ui通用页面样式
* @author: liwei
* @update: 2014-11-11 18:00
*/

模块注释
/* Global */
body {min-width:320px;line-height:1.5;color:#333;background:#F2F2F2;}

• (2) class 和 id 命名规范, 都采用驼峰 或者 "_"

//规范
.site_map {
	
}

//规范
.siteMap { 

}

[javascrip 规范]

• (1) 变量命名要有意义,都采用驼峰方式

//不规范
var SiteMap;

//不规范
var Site_Map;

//规范
var siteMap;

• (2) 注释规范

// 回调函数
function callback() {
	
}

// 网站导航
var siteMap;

• (3) 标点后面加一个空格，前面不加空格; 操作符前后各加一个空格

//不规范
for (var i=0;i<l;i++) {
} 

//规范
for (var i = 0; i < l; i++) { 
} 

• (4) 函数命名规范,如下

//不规范
$("#click").click(
	function(){

	}
);

规范
$("#click").click(function(){

});

//不规范
function callback()
{

}

//不规范
function callback(){

}

//规范
function callback() {
	
} 

• (5) 更多的规范地址:JavaScript规范