2).多行注释

多行注释应当在代码需要更多文字去解释的时候使用.每个多行注释都至少有如下三行. 1.首行仅仅包括 /* 注释开始.该行不应当有其他文字 2.接下来的行以 * 开头并保持左对齐.这些行可以由文字描述 3.最后一行以 */开头并同先前行保持对齐.也不应当有其他文字

多行注释的首行应当保持同它描述代码的相同层次的缩进.后续的每行应当有同样层次的缩进并附加一个空格(为了适当保持 * 字符的对齐).每一个多行代码之前应当预留一个空格

// 好的写法 // TODO: 我希望找到一种更快的方式 doSomething(); // 不好的写法: 注释声明空格不正确 // TODO : 我希望找到一种更快的方式 doSomething(); // 好的写法 // REVIEW: 有更好的方法吗? doSomething(); // 不好的写法: 代码和注释应当保持同样的缩进 // REVIEW: 有更好的方法吗? doSomething(); 

8.命名

变量命名应当采用驼峰命名格式,首字母小写,每个单词首字母大写.变量名的第一个单词应当是一个名词(而非动词)比避免同函数混淆.不要在变量名中使用下划线

// 好的写法 const myName = 'Jack'; // 不好的写法: 大写字母开头 const MyName = 'Jack'; // 不好的写法: 动词开头 const getMyName = 'Jack'; // 不好的写法: 使用下划线 const my_name = 'Jack'; 

// 好的写法 function doSomething() { // 代码 } // 不好的写法: 大写字母开头 function DoSomething() { // 代码 } // 不好的写法: 名词开头 function car() { // 代码 } // 不好的写法: 使用下划线 function do_something() { // 代码 } 

// 好的写法 function MyObject() { } // 不好的写法: 小写字母开头 function myObject() { } // 不好的写法: 使用下划线 function My_Object() { } // 不好的写法: 动词开头 function getMyObject() { } 

// 好的写法 const TOTAL_COUNT = 10; // 不好的写法 const totalCount = 10; // 不好的写法: 混合模式 const total_COUNT = 10;

// 好的写法 const object = { _count: 10, _getCount: function() { return this._count; } }

9.赋值

当给变量赋值时,如果右侧是含有比较语句的表达式,需要用圆括号包裹

// 好的写法 const flag = (i < count); // 不好的写法:遗漏圆括号 const flag = i < count;

10.等号运算符

使用 === (严格相等) 和 !==(严格不相等)代替 ==(相等) 和 !=(不等) 来避免弱类型转换错误

// 好的写法 const same = (a === b); // 不好的写法: 使用 == const same = (a == b);

11.三元操作符

三元运算符应当仅仅用在条件赋值语句中,而不要作为if语句的替代品.

// 好的写法 const value = condition ? value1 : value2; // 不好的写法: 没有赋值,应当使用 if 表达式 condition ? doSomething() : doSomethingElse();

12.语句

简单语句

每一行最多只包含一条语句.所有简单的语句都应该以分号(;)结束.

// 好的写法 const a = 1; const b = 2; const c = a + b; // 不好的写法: 多个表达式写在一行 const a = 1;const b = 2;const c = a + b;

返回语句

返回语句当返回一个值的时候不应当使用圆括号包裹,除非在某些情况下这么做可以让返回值更容易理解.例如:

return; return collection.size(); return (size > 0 ? size : defaultSize)

if (condition) { statements } else if (condition) { statements } else { statements }

switch (expression) { case expression: statements default: statements }

// 好的写法 switch (value) { case 1: /* falls through */ case 2: doSomething(); break; case 3: return true; default: throw new Error('this should not happen'); }

try语句

try { statements } catch (constiable) { statements } finally { statements }

// 好的写法 function doSomething(arg1, agr2) { return arg1 + arg2; } // 不好的写法: 第一行不恰当的空格 function doSomething (arg1, agr2) { return arg1 + arg2; } // 不好的写法: const doSomething = function doSomething(arg1, agr2) { return arg1 + arg2; } // 不好的写法: 左侧的花括号位置不对 function doSomething(arg1, agr2) { return arg1 + arg2; } // 错误的写法: 使用Function构造器 const doSomething = new Function('arg1', 'agr2', 'return arg1 + arg2'); 

/* eslint-disable */

npm i --save-dev pre-commit

{ "scripts": { "eslint": "eslint ./ --ext js,vue --ignore-pattern .eslintignore --cache --fix", "lint-message": "echo '开始 eslint 检查, 存在 error 则会拒绝提交'"   },   "pre-commit": [ "lint-message", "eslint" // 进行eslint检查并自动修复一些简单的格式错误   ], } 

{ "eslint.autoFixOnSave": true, "eslint.enable": true, "eslint.options": { "extensions": [".js", ".vue", ".jsx"] }, "eslint.validate": [ { "language": "vue", "autoFix": true }, { "language": "javascript", "autoFix": true }, { "language": "javascriptreact", "autoFix": true } ], }