JavaScript编码风格指南

时间  2019-11-16
标签 javascript 编码 风格 指南 栏目 JavaScript 繁體版
原文   原文链接

首次发表在我的博客javascript

前言

程序语言的编码风格指南对于一个长期维护的软件而言是很是重要的;好的编程风格有助于写出质量更高、错误更少、更易于 维护的程序。html

团队合做须要制定一些代码规范还有利用一些工具来强制要求团队代码的风格统一.毕竟不少状况下之后不必定是由写一手代码的人来维护代码,因此有一个统一的代码风格很重要!!!前端

最近看了一下编写可维护的JavaScript和编写高质量代码:Web前端开发修炼之道,根据书中提倡的一些写法,同时结合我我的的经验和喜爱作了一些改动,大体整理了以下JavaScript编码风格vue

JavaScript编码风格

1.缩进

每一行的层级由4个空格组成,避免使用制表符(Tab)进行缩进java

if (true) {
    doSomething();
}
复制代码

2.行的长度

每行长度不该该超过80个字符.若是一行多于80个字符,应当在一个运算符(逗号,加好等)后换行.下一级应当增长两级缩进(8个字符).react

// 好的写法
doSomething(arg1, arg2, arg3, arg4,
        arg5);

// 很差的写法: 第二行只有4个空格的缩进
doSomething(arg1, arg2, arg3, arg4,
    arg5);
// 很差的写法: 在运算符以前换行
doSomething(arg1, arg2, arg3, arg4
        ,arg5);
复制代码

3.原始值

特殊值null除了下述状况应当避免使用git

  • 用来初始化一个变量,这个变量可能被赋值为一个对象
  • 用来和一个已经初始化的变量比较,这个变量能够是也能够不是一个对象
  • 当函数的参数指望是对象时,被用做返回值传出
// 好的作法
const person = null;
复制代码

判断一个变量是否认义应当使用 typeof 操做符es6

// 好的写法
if (typeof constiable == 'undefined') {
    // do something
}

// 很差的写法
if (constiable == 'undefined') {
    // do something
}
复制代码

4.运算符间距

二元运算符先后必须使用一个空格来保持表达式的整洁.操做符包括赋值运算符和逻辑运算符express

// 好的写法
const found = (values[i] === item);
// 很差的写法: 丢失了空格
const found = (values[i]===item);

// 好的写法
if (found && (count > 10)) {
    doSomething();
}
// 很差的写法: 丢失了空格
if (found&&(count>10)) {
    doSomething();
}

// 好的写法
for(let i = 0; i < count; i++) {
    process(i);
}
// 很差的写法: 丢失了空格
for(let i=0; i<count; i++) {
    process(i);
}
复制代码

5.括号间距

当使用括号时,紧接左括号以后和紧接右括号以前不该该有空格npm

// 好的写法
const found = (values[i] === item);
// 很差的写法: 左括号以后有额外的空格
const found = ( values[i] === item);

// 好的写法
if (found && (count > 10)) {
    doSomething();
}
// 很差的写法: 右括号以后有额外的空格
if (found && (count > 10) ) {
    doSomething();
}

// 好的写法
for(let i = 0; i < count; i++) {
    process(i);
}
// 很差的写法: 参数两边有额外的空格
for(let i = 0; i< count; i++) {
    process( i );
}
复制代码

6.对象直接量

对象直接量应当使用以下格式

  • 起始左花括号应当同表达式保持同一行
  • 每一个属性的名值对应当保持一个缩进,第一个属性应当在左花括号后另起一行.
  • 每一个属性的名值对应当使用不含引号的属性名,其后紧跟一个冒号(以前不含空格),然后是值
  • 假若属性值是函数类型,函数体应当在属性名之下另起一行,并且其先后均应保留一个空行
  • 一组相关的属性先后能够插入空行以提升代码的可读性
  • 结束的右花括号应当独占一行
// 好的写法
const object = {

    key1: value1,
    key2: value2,

    func: function() {

    },

    key3: value3,
};

// 很差的写法: 不恰当的缩进
const object = {
        key1: value1,
        key2: value2,
    };

// 很差的写法:函数体缺乏空行
const object = {

    key1: value1,
    key2: value2,
    func: function() {

    },
    key3: value3,
};
复制代码

当对象字面量做为函数参数时,若是值是变量,起始花括号应当同函数名在同一行.全部其他先前列出的规则一样适用

// 好的写法
doSomething({
    key1: value1,
    key2: value2,
});

// 很差的写法
doSomething({ key1: value1, key2: value2 });
复制代码

7.注释

频繁地适用注释有助于他人理解你的代码.以下状况应当使用注释

  • 代码晦涩难懂
  • 可能被误认为错误的代码
  • 必要但不明显的针对特定浏览器的代码
  • 对于对象,方法或者属性,生成文档是有必要的(使用恰当的文档注释).

1).单行注释

使用单行注释当用来讲明一行代码或者一组代码.单行注释可能有三种使用方式

  • 独占一行的注释,用来解释下一行代码
  • 在代码行的尾部的注释,用来解释它以前的代码
  • 多行,用来注释掉一个代码块
// 好的写法
if (condition) {

    // 若是代码执行到这里,则说明经过了全部的安全性检测
    allowed();
}

// 很差的写法:注释以前没有空行
if (condition) {
    // 若是代码执行到这里,则说明经过了全部的安全性检测
    allowed();
}

// 很差的写法: 错误的缩进
if (condition) {

// 若是代码执行到这里,则说明经过了全部的安全性检测
    allowed();
}

// 很差的写法: 这里应当用多行注释
// 接下来的这段代码很是难, 那么,让我详细的解释一下
// 1. xxxx
// 2. xxxx
if (condition) {

// 若是代码执行到这里,则说明经过了全部的安全性检测
    allowed();
}
复制代码

对于代码行尾单行注释的状况,应确保代码结尾同注释之间至少一个缩进

// 好的写法
const result = something + somethingElse; // somethingElse will never be null

// 很差的写法: 代码和注释间没有足够的空格
const result = something + somethingElse;// somethingElse will never be null
复制代码

注释一个代码块时在连续多行使用单行注释是惟一能够接受的状况.多行注释不该当在这种状况下使用

// 好的写法
// if(condition) {
// doSomething();
// }
复制代码

2).多行注释

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

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

// 好的写法
if (condition) {

    /* * 若是代码执行到这里 * 说明经过了全部的安全性检测 */
    allowed();
}

// 很差的写法: 注释以前无空行
if (condition) {
    /* * 若是代码执行到这里 * 说明经过了全部的安全性检测 */
    allowed();
}
// 很差的写法: 星号后没有空格
if (condition) {

    /* *若是代码执行到这里 *说明经过了全部的安全性检测 */
    allowed();
}
// 很差的写法: 错误的缩进
if (condition) {

/* * 若是代码执行到这里 * 说明经过了全部的安全性检测 */
    allowed();
}

// 很差的写法: 代码尾部注释不要用多行注释格式
const result = something + somethingElse; /* somethingElse 不该当取值为null */
复制代码

3)注释声明

注释有时候能够用来给一段代码声明额外的信息.这些声明的格式以单个单词打头并紧跟一个双引号.可以使用的声明以下

  • TODO: 说明代码还未完成.应当包含下一步要作的事情
  • HACK: 代表代码实现走了一个捷径
  • XXX: 说明代码是有问题的并应当尽快修复
  • FIXME: 说明代码是有问题的并应当尽快修复.重要性略次于XXX
  • REVIEW: 说明代码任何可能的改动都须要评审 这些声明可能在一行或多行注释中使用,而且应当遵循同通常注释类型相同的格式规则
// 好的写法
// 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() {
    // 代码
}
复制代码

构造函数--经过new元素安抚建立新对象的函数--也应使用驼峰合适命名,首先首字母大写.构造函数命名应当以非动词开头,由于new表明着建立一个对象实例的操做

// 好的写法
function MyObject() {

}
// 很差的写法: 小写字母开头
function myObject() {
    
}
// 很差的写法: 使用下划线
function My_Object() {
    
}
// 很差的写法: 动词开头
function getMyObject() {
    
}
复制代码

常量(不会被改变的变量)的命名应当是全部字母大写,不一样单词之间用单个下划线隔开.ES6中使用const来声明一个常量

// 好的写法
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或者for语句,全部语句都须要用打括号括起来,也包括单个语句.这个约定使得咱们更方便地添加语句而不用担忧忘记加括号而引发bug
  • 像if同样的语句开始的关键词,其后应当紧跟一个空格,起始大括号应当在空格以后

if语句

if (condition) {
    statements
} else if (condition) {
    statements
} else {
    statements
}
复制代码

毫不容许在if语句中省略花括号

// 好的写法
if (condition) {
    doSomething();
} 
// 很差的写法: 不恰当的空格
if(condition){
    doSomething();
} 
// 很差的写法: 遗漏花括号
if (condition) 
    doSomething();

// 很差的写法: 全部代码写在一行
if (condition) { doSomething(); }
// 很差的写法: 全部代码写在一行且没有花括号
if (condition) doSomething();

复制代码

for语句

for (initialization; condition; update) {
    statements
}

for (constiable in object) {
    statements
}
复制代码

当使用 for-in 语句时,记得使用 hasOwnProperty() 进行双重检查来过滤出对象的成员

while语句

while (condition) {
    statements
}
复制代码

do语句

do {
    statements
} while (condition)
复制代码

switch语句

switch (expression) {
    case expression:
        statements
    default:
        statements
}
复制代码

switch下的每个case都叮当保持一个缩进.除第一个以外包括default在内的每个case都应当在以前保持一个空行 每一组语句(除了default)都应当以break, return, throw结尾,或者用一行注释表示跳过

// 好的写法
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
}
复制代码

13.严格模式

严格模式应当仅限在函数内部使用,千万不要在全局使用.

ES6 的模块自动采用严格模式，无论你有没有在模块头部加上"use strict";。

14.变量声明

全部的变量在使用前都应事先定义.变量定义应放在函数开头. 变量定义前应当初始化,而且赋值操做符应当保持一致的缩进.初始化的变量应当在未初始化变量以前.

推荐使用ES6的let和 const来声明变量

15.函数声明

函数声明应当在使用前提早定义. 一个不是做为方法的函数(也就是没有做为一个对象的属性)应当使用函数定义的格式(不是函数表达式和Function构造器格式). 函数名和开始圆括号以前不该当有空格.结束的圆括号和右边的花括号之间应该留一个空格.右侧的花括号应当同function关键字保持同一行.开始和结束括号之间不该该有空格.参数名之间应当在逗号以后保留一个空格.函数体应当保持一级缩进

// 好的写法
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');
复制代码

16.留白

在逻辑相关的代码块之间添加空行能够提升代码的可读性

两行空行权限在以下状况使用

  • 在不一样的源代码文件之间
  • 在类和接口定义之间

单行空行权限在以下状况使用

  • 方法之间
  • 方法中局部变量和第一行语句之间
  • 多行或单行注释以前
  • 方法中逻辑代码块之间以提升代码的可读性

空格应当在以下状况中使用

  • 关键词后跟括号的状况应当用空格隔开
  • 参数列表中逗号以后应当保留一个空格
  • 全部的除了点(.)以外的二元运算符,其操做数都应当用空格隔开.单目运算符的操做数之间不该该用空白隔开,诸如一元减号,递增(++),递减(--)
  • for语句中的表达式之间应当用空格隔开

17. 须要避免的

  • 切勿使用像String一类的原始包装类型建立的新对象
  • 避免使用eval()
  • 避免使用with语句.改语句在严格模式中不复存在,可能在将来也将去除

使用工具(eslint)来强制约束

eslint 规则

eslint规则在.eslintrc.js中定义,以为不合理的能够禁掉某条规则,或者有好的建议的也能够添加; 主要注意一下几条:

  • 代码缩进用4空格
  • 语句必须默认后加分号
  • 使用单引号
  • 提交代码前将console.log语句删掉或注释掉(否则影响其余开发人员调试)
  • 禁止使用const,使用es6的let,const声明变量

还有一些状况是不须要检测的,例如第3方的库, 框架、组件、ui库等等,能够将这些文件放在.eslintignore文件中,能够忽略eslint的检测

在文件顶部加上下面这行,能够禁掉整个文件的eslint规则

/* eslint-disable */
复制代码

pre-commit

代码提交以前会强制code-review,不符合规范的不容许提交代码 使用方法 1.在命令行安装

npm i --save-dev pre-commit
复制代码

2.在package.json中配置

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

复制代码

代码提交以前会强制code-review,不符合规范的不容许提交代码

若是项目实在没时间去改的话，能够 git commit -m 'XXX' --no-verify 或 git commit -n 'xxx'强制提交

小技巧-vscode能够配置保存自动修复eslint错误

vscode安装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
          }
      ],
}

复制代码

配置完成以后,每次保存,都会自动根据 .eslintrc.js文件自动修复空格,分号的错误;可是最好仍是在日常的编码中养成一个良好的习惯,而不是依赖工具.

下列参考给出的文章及书籍，有时间必定要好好看一下，会帮助你们深入理解JavaScript编码风格的重要性。永远记住，规范能解决大部分问题。

参考

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程