15个简单的JS编码标准让你的代码更整洁

做者 | Daniel Anderson

本文最初发布于 Medium 网站，经原做者受权后翻译和分享。

编码标准能够帮助如下方面：

• 保持代码一致
• 易于阅读和理解
• 易于维护

下面的编码标准是我对上述几点有帮助的见解。

1. 比较时使用 === 代替 ==

这很重要，由于JavaScript是一种动态语言，所以使用==可能会给您带来意想不到的结果，由于它容许类型不一样。

Fail：

if (val == 2)
复制代码

Pass：

if (val === 2)
复制代码

2. 永远不要使用 var，使用 let 来代替

使用 let 将有助于避免 JavaScript 中各类 var 引发的做用域问题。

Fail：

var myVar = 10;
复制代码

Pass：

let myVar = 10;
复制代码

3. 使用 const 代替 let

这阻止了开发人员尝试更改不该该作的事情，而且确实有助于提升可读性。

Fail：

let VAT_PERCENT = 20;
复制代码

Pass：

const VAT_PERCENT = 20;
复制代码

4. 始终使用分号（;）

尽管这在 JavaScript 中是可选的，并不像其它语言同样须要分号做为语句终止符。可是使用 ; 有助于使代码保持一致。

Fail：

const VAT_PERCENT = 20;
let amount = 10
return addVat(amount, vatPercent)
复制代码

Pass：

const vatPercent = 20;
let amount = 10;
return addVat(amount, vatPercent);
复制代码

5. JavaScript中的命名约定

• let 应该使用驼峰命名。

• const 若是在文件的顶部使用大写的蛇形命名法。若是不在文件顶部，请使用驼峰命名。

• class 应该是帕斯卡命名法:MyClass

• functions 函数应该是驼峰命名法:myFunction

6. 拼接字符串时使用模板字符串

模板字符串中容许嵌入表达式。

Fail：

let fullName = firstName + " " + lastName;
复制代码

Pass：

let fullName = `${firstName} ${lastName}`;
复制代码

7. 尽量使用ES6箭头函数

箭头函数是编写函数表达式的更简洁的语法。

Fail：

var multiply = function(a, b) {
  return a* b;
};
复制代码

Pass：

const multiply = (a, b) => { return a * b};
复制代码

8. 始终在控制结构周围使用大括号

全部控制结构都必须使用花括号（例如，if，else，for，do，while等），这样后期维护时，不容易出错。

Fail：

if (valid)
   doSomething();
if (amount > 100) 
    doSomething();
else if(amount > 200)
    doSomethingElse();
复制代码

Pass：

if (valid) {
   doSomething();
}
if (amount > 100) {
   doSomething();
} 
else if(amount > 200) {
    doSomethingElse();
}
复制代码

9. 确保大括号从同一行开始，中间有空格

Fail：

if (myNumber === 0)
{
    doSomething();
}
复制代码

Pass：

if (myNumber === 0) {
    doSomething();
}
复制代码

10. 尝试减小嵌套

if 内的 if 会变得混乱而且很难阅读。有时你可能没法解决问题，可是能够好好卡看看代码结构，看看是否能够改进。

Fail：

if (myNumber > 0) {
  if (myNumber > 100) {
       if (!hasDiscountAlready) {
           return addDiscountPercent(0);
       } else {
           return addDiscountPercent(10);
       }
  } else if (myNumber > 50) {
    if (hasDiscountAlready) {
       return addDiscountPercent(5);
    }
  } else {
    if (!hasDiscountAlready) {
      return addDiscountPercent(0);
    } else {
      return addDiscountPercent(1);
    }
  }
} else {
     error();
}
复制代码

Pass：

if (myNumber <= 0) {
   return error;
}
if (!hasDiscountAlready) {
    return addDiscountPercent(0);
}
if (myNumber > 100) { 
    return addDiscountPercent(10);
}
if (myNumber > 50) { 
    return addDiscountPercent(5);
}
return addDiscountPercent(1);
复制代码

经过上面的示例能够看出，减小嵌套以后，会变得容易阅读。

11. 尽量使用默认参数

在 JavaScript 中，若是你在调用函数时没有传递参数，则它的值就是 undefined

Fail：

myFunction(a, b) {
  return a + b;
}
复制代码

Pass：

myFunction(a = 0, b = 0) { 
   return a + b;
}
复制代码

12. `Switch` 语句应使用 `break` 并具备 `default`

我一般会尝试不使用 switch 语句，可是你确实想使用它，请确保每一个条件都 break ，并写了 defalut。

Fail：

switch (myNumber)
{
  case 10: 
   addDiscountPercent(0);
  case 20: 
   addDiscountPercent(2);
  case 30:
   addDiscountPercent(3);
}
复制代码

Pass：

switch (myNumber)
{
  case 10: 
    addDiscountPercent(0);
    break;
  case 20: 
    addDiscountPercent(2);
    break;
  case 30:
    addDiscountPercent(3);
    break;
  default: 
    addDiscountPercent(0);
    break;
}
复制代码

13. 不要使用通配符导入

Fail：

import * as Foo from './Foo';
复制代码

Pass：

import Foo from './Foo';
复制代码

14. 使用布尔值的快捷方式

Fail：

if (isValid === true)
if (isValid === false)
复制代码

Pass：

if (isValid)
if (!isValid)
复制代码

15. 尝试避免没必要要的三元语句

Fail：

const boo = a ? a : b;
复制代码

Pass：

const boo = a || b;
复制代码

总结

任何语言的编码标准均可以真正帮助提升应用程序的可读性和可维护性。若是你在团队中工做，那么一件很难的事情就是强制执行编码标准。这里有一些建议能够帮助你：

• 代码审查，逐行Pass代码。
• 整理或使用某种代码分析器
• 建立新内容时，让大家的一位高级开发人员初始化，其余开发人员可使用该代码做为指导。

原文连接: https://medium.com/javascript-in-plain-english/19-simple-javascript-coding-standards-to-keep-your-code-clean-7422d6f9bc0

好嘛，若是看到这里，说明是真爱了。要不要给个人 Github 增长一个 star。

若有翻译不当的地方，多多包涵，欢迎在评论区指正~

关注公众号，加入技术交流群