前端代码规范（参考腾讯前端规范）

命名

驼峰命名

• 采用驼峰命名法

大驼峰命名：首字母大写
小驼峰命名：首字母小写

文件资源命名

1. 文件名建议只用小写，不使用大写字母（为了提醒，某些说明文件可以使用大写，比如README）
2. 文件名包含多个单词时，单词之间建议使用连词线（-）分割
3. 引入资源使用相对路径，不要指定资源的具体协议（http，https）

 <script src = "//cdn.com/a.js"></script>

变量命名

采用小驼峰命名法
命名规范：类型+对象描述的方式，如果没有具体的类型，就可以使前缀为名词

类型	小写字母
array	a
boolean	b
function	fn
int	i
object	o
regular	r
string	s

比如：var tableTitle = ‘LoginTable’

函数命名

命名方式：采用小驼峰命名方式（构造函数采用大驼峰命名）
命名规则：前缀为为动词

动词	含义	返回值
can	判断是否可以执行某个动作（权限）	函数返回一个布尔值，true为可执行
has	判断是否含有某个值	函数返回一个布尔值
is	判断是否为某个值	函数返回一个布尔值
get	判断是否为某个值	函数返回一个非布尔值
set	设置某个值	无返回值

//是否可以阅读
function canRead(){
	return true;
}
//获取姓名
function getName(){
	return this.name;
}

常量

命名方法：全部大写
命名规范：使用大写字母与下划线来组合命名，下划线用来分割单词

var MAX_COUNT = 10;
var URL = 'http://www.baidu.com';

类的成员

公共属性与方法：同变量名命名方式
私有属性与方法：前缀为”_”

function Student(name) {
	var _name = name; // 私有成员
	// 公共方法
	this.getName = function(){
		return _name;
	}
	this.setName = function(value){
		_name = value;
	}
}
var st = new Student('tom');
st.setName('jerry');

注释规范

单行注释

• 单独一行：//（双斜线）与注释文字之间保留一个空格
• 在代码后面添加注释：//（双斜线）与代码之间保留一个空格，并且与注释文字保留一个空格
• 注释代码：//（双斜线）与代码之间保留一个空格

// 单独在一行
setTitle(); // 在代码后面
// setTitile();

多行注释

• 若开始与结束都在一行，推荐单行注释
• 若至少三行注释时，第一行为/，最后一行为*/，其他行都以开始，并且与注释文字保留一个空格

/*
* 我是多行注释
*/

函数注释

注释名	语法	含义	实例
@param	@param 参数名 {类型描述} 描述信息	描述参数的信息	@param name {String} 传入名称
@return	@return {返回类型} 描述信息	描述返回值的信息	@return {Boolean} true:可执行；false:不可执行
@author	@author 作者信息[附属信息：如邮箱，日期]	描述此函数的作者信息	@author 张三 2015/07/21
@version	@version XX.XX.XX	描述此函数的版本号	@version 1.0.3
@example	@example示例代码	@example setTitle(‘测试’)	如下

/**
	@param grid {Number} 需要合并的行
	@param cols {Array} 需要合并的列,下标index从0开始计数
	@param isAllSome {Boolean} 是否可以合并，true：完全一样，false（默认）：不完全一样
	@return void
*/

html规范