1. 命名规范

1.1 变量

命名方法：小驼峰式命名法。
命名规范：前缀应当是名词。(函数的名字前缀为动词，以此区分变量和函数)
命名建议：尽量在变量名字中体现所属类型，如:length、count等表示数字类型；而包含name、title表示为字符串类型。

1.2 函数

命名方法：小驼峰式命名法。
命名规范：前缀应当为动词。
命名建议：可使用常见动词约定can、has、is、get、set、load等

1.3 常量

命名方法：名称全部大写。
命名规范：使用大写字母和下划线来组合命名，下划线用以分割单词。
命名建议：无。

1.4 构造函数

命名方法：大驼峰式命名法，首字母大写。
命名规范：前缀为名称。
命名建议：无。

1.5 类的成员

类的成员包含：
① 公共属性和方法：跟变量和函数的命名一样。
② 私有属性和方法：前缀为_(下划线)，后面跟公共属性和方法一样的命名方式。

1
2
3
4
5
6
7
8
9
10
11
function Student(name) {
    var _name = name; // 私有成员
    // 公共方法
    this.getName = function () {
        return _name;
    }
    // 公共方式
    this.setName = function (value) {
        _name = value;
    }
}

2. 注释规范

2.1 单行注释

① 单独一行：//(双斜线)与注释文字之间保留一个空格。
② 在代码后面添加注释：//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格。
③ 注释代码：//(双斜线)与代码之间保留一个空格。

2.2 多行注释

推荐JSDoc写法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
/**
* @method TODO
* @description TODO的注释示例
* @param {Object} obj - 必填项，以json对象形式传参
* @param {String} obj.orderId 选填项，订单id
* @param {callback} [callback] 选填项，回调函数
* @return void
* @author tentou 2017/08/24 
* @version 1.0.3
* @example 
*     var obj = {
*          "orderId": "761445290146316289"
*     };
*     TODO(obj,callback);
*/
function TODO (obj,callback) {
  // Do Something
}

JSDoc文档

参考文献

JavaScript 开发规范

others, 规范，命名
← Prev Next →