javascript代码规范

• 注释

// 文件注释
/**
 * --------------------------------------------------
 * 文件描述：实现功能、模块、接口、使用说明、范例
 * @version  版本号
 * @author   作者(联系方式)
 * @date      文件创建日期
 * --------------------------------------------------
 **/

// 接口注释
/**
 * --------------------------------------------------
 * 接口描述：实现功能、使用说明、范例
 * @param  {参数类型}  参数名称
 * @return   {返回类型}
 * @author  作者(联系方式)  *可选
 * @date     文件创建日期     *可选
 * --------------------------------------------------
 **/

// class注释
/**
 * --------------------------------------------------
 * 功能描述：描述对象及基本功能、使用说明、范例
 * @class      当前class
 * @extends  继承父class
 * @param    {参数类型}  参数名
 * @author    作者(联系方式)  *可选
 * @date       文件创建日期     *可选
 * --------------------------------------------------
 **/
// 内部注释
// 注释内容

• 命名

// 命名空间
首字母小写
// class
首字母大写
// 私有属性/接口
__  前缀
// 公共属性/接口
_$  前缀
// 变量
全局变量  g_
临时变量/参数  _
// 常量
全部大写字母
// 枚举型
对象名大写，枚举量小写
// 事件
加事件名称后缀
// 方法
首字母小写

• 格式

// 空格
操作符前后空一格
逗号、分号、冒号后空一格
空行、空对象、空数组不填入空格
// 缩进
条件语句
声明多个变量
多行数组元素
多行对象值
// 换行
表达式过长，合适位置换行
多参数，合适位置换行
匿名函数体
过长三元操作符