JavaScript中的开发规范

注释

As short as possible（如无必要，勿增注释）：尽量提高代码本身的清晰性、可读性。 As long as necessary（如有必要，尽量详尽）：合理的注释、空行排版等，可以让代码更易阅读、更具美感。

单行注释

必须独占一行。// 后跟一个空格，缩进与下一行被注释说明的代码一致。

多行注释

避免使用 /…/ 这样的多行注释。有多行注释内容时，使用多个单行注释。

函数/方法注释

函数/方法注释必须包含函数说明，有参数和返回值时必须使用注释标识。；

参数和返回值注释必须包含类型信息和说明；

当函数是内部函数，外部不可访问时，可以使用 @inner 标识；

文件注释

文件注释用于告诉不熟悉这段代码的读者这个文件中包含哪些东西。 应该提供文件的大体内容, 它的作者, 依赖关系和兼容性信息。如下:

命名

变量, 使用 Camel 命名法。

私有属性、变量和方法以下划线 _ 开头。

常量, 使用全部字母大写，单词间下划线分隔的命名方式。

函数, 使用 Camel 命名法。

函数的参数, 使用 Camel 命名法。

类, 使用 Pascal 命名法。

类的 方法 / 属性, 使用 Camel 命名法。

枚举变量 使用 Pascal 命名法。

枚举的属性， 使用全部字母大写，单词间下划线分隔的命名方式。

由多个单词组成的 缩写词，在命名中，根据当前命名法和出现的位置，所有字母的大小写与首字母的大小写保持一致。

接口命名规范

可读性强，见名晓义；

尽量不与 jQuery 社区已有的习惯冲突；

尽量写全。不用缩写，除非是下面列表中约定的；（变量以表达清楚为目标，uglify 会完成压缩体积工作）

True 和 False 布尔表达式

类型检测优先使用 typeof。对象类型检测使用 instanceof。null 或 undefined 的检测使用 == null。

下面的布尔表达式都返回 false:

1.null 2.undefined 3.‘’ 空字符串 4. 0 数字0

但小心下面的, 可都返回 true:

1.‘0’ 字符串0 2.[] 空数组 3.{} 空对象

不要在 Array 上使用 for-in 循环

for-in 循环只用于 object/map/hash 的遍历, 对 Array 用 for-in 循环有时会出错. 因为它并不是从 0 到 length - 1 进行遍历, 而是所有出现在对象及其原型链的键值。

二元和三元操作符

操作符始终写在前一行, 以免分号的隐式插入产生预想不到的问题。

条件(三元)操作符 (??

三元操作符用于替代 if 条件判断语句。

语言规范

1.声明变量必须加上 let 关键字.不要再使用 var

2.优先使用箭头函数

3.使用模板字符串取代连接字符串 ${a}+ ${b} ‘a’+‘b’

使用分号

如果仅依靠语句间的隐式分隔,有时会很麻烦,使用分号更能清楚哪里是语句的起止,而且有些情况下,漏掉分号会出 BUG

var a = 1 ；

块内函数声明

不要在块内声明一个函数

如果确实需要,使用函数表达式来初始化变量

if (x) {  //不推荐
      function fn() {}
  }

if (x) {  //推荐
      let fn = function() {}
  }

标点规范

js中统一使用反引号（``）或是单引号(’’)， 不使用双引号("")

回调函数规范

回调函数统一使用 Promise 函数,回调成功的参数统一为 res,错误参数为 err。

let callback = new Promise((resolve, reject) => {
        if (/* 异步操作成功 */){
            resolve(value);
        } else {
            reject(err);
        }
    });

    callback.then((res) => {
        console.log('成功回调！', res);
    }).catch((err) => {
        console.log('失败回调！', err);
    });
———

导入和导出

使用import和export,只能位于代码顶部和顶部,如果代码中部需要按需导入文件使用require。