|
|
51CTO旗下网站
|
|
移动端

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

编码标准可以帮助以下方面:保持代码一致;易于阅读和理解;易于维护。下面的编码标准是我对上述几点有帮助的看法。

作者:刘小夕来源:前端宇宙|2020-07-15 08:37

 编码标准可以帮助以下方面:

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

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

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

这很重要,因为JavaScript是一种动态语言,因此使用==可能会给您带来意想不到的结果,因为它允许类型不同。

Fail:

  1. if (val == 2) 

Pass:

  1. if (val === 2) 

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

使用 let 将有助于避免 JavaScript 中各种 var 引起的作用域问题。

Fail:

  1. var myVar = 10; 

Pass:

  1. let myVar = 10; 

3. 使用 const 代替 let

这阻止了开发人员尝试更改不应该做的事情,并且确实有助于提高可读性。

Fail:

  1. let VAT_PERCENT = 20; 

Pass:

  1. const VAT_PERCENT = 20; 

4. 始终使用分号(;)

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

Fail:

  1. const VAT_PERCENT = 20; 
  2. let amount = 10 
  3. return addVat(amount, vatPercent) 

Pass:

  1. const vatPercent = 20; 
  2. let amount = 10; 
  3. return addVat(amount, vatPercent); 

5. JavaScript中的命名约定

  • let 应该使用驼峰命名。
  • const 如果在文件的顶部使用大写的蛇形命名法。如果不在文件顶部,请使用驼峰命名。
  • class 应该是帕斯卡命名法:MyClass
  • functions 函数应该是驼峰命名法:myFunction

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

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

Fail:

  1. let fullName = firstName + " " + lastName; 

Pass:

  1. let fullName = `${firstName} ${lastName}`; 

7. 尽可能使用ES6箭头函数

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

Fail:

  1. var multiply = function(a, b) { 
  2.   return a* b; 
  3. }; 

Pass:

  1. const multiply = (a, b) => { return a * b}; 

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

所有控制结构都必须使用花括号(例如,if,else,for,do,while等),这样后期维护时,不容易出错。

Fail:

  1. if (valid) 
  2.    doSomething(); 
  3. if (amount > 100)  
  4.     doSomething(); 
  5. else if(amount > 200) 
  6.     doSomethingElse(); 

Pass:

  1. if (valid) { 
  2.    doSomething(); 
  3. if (amount > 100) { 
  4.    doSomething(); 
  5. }  
  6. else if(amount > 200) { 
  7.     doSomethingElse(); 

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

Fail:

  1. if (myNumber === 0) 
  2.     doSomething(); 

Pass:

  1. if (myNumber === 0) { 
  2.     doSomething(); 

10. 尝试减少嵌套

if 中嵌套if 会变得混乱并且很难阅读。有时你可能无法解决问题,但是可以好好查看代码,看看是否可以改进。

Fail:

  1. if (myNumber > 0) { 
  2.   if (myNumber > 100) { 
  3.        if (!hasDiscountAlready) { 
  4.            return addDiscountPercent(0); 
  5.        } else { 
  6.            return addDiscountPercent(10); 
  7.        } 
  8.   } else if (myNumber > 50) { 
  9.     if (hasDiscountAlready) { 
  10.        return addDiscountPercent(5); 
  11.     } 
  12.   } else { 
  13.     if (!hasDiscountAlready) { 
  14.       return addDiscountPercent(0); 
  15.     } else { 
  16.       return addDiscountPercent(1); 
  17.     } 
  18.   } 
  19. else { 
  20.      error(); 

Pass:

  1. if (myNumber <= 0) { 
  2.    return error; 
  3. if (!hasDiscountAlready) { 
  4.     return addDiscountPercent(0); 
  5. if (myNumber > 100) {  
  6.     return addDiscountPercent(10); 
  7. if (myNumber > 50) {  
  8.     return addDiscountPercent(5); 
  9. return addDiscountPercent(1); 

通过上面的示例可以看出,减少嵌套之后,会变得容易阅读。

11. 尽可能使用默认参数

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

Fail:

  1. myFunction(a, b) { 
  2.   return a + b; 

Pass:

  1. myFunction(a = 0, b = 0) {  
  2.    return a + b; 

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

我通常会尝试不使用 switch 语句,但是你确实想使用它,请确保每个条件都 break ,并写了 defalut。

Fail:

  1. switch (myNumber) 
  2.   case 10:  
  3.    addDiscountPercent(0); 
  4.   case 20:  
  5.    addDiscountPercent(2); 
  6.   case 30: 
  7.    addDiscountPercent(3); 

Pass:

  1. switch (myNumber) 
  2.   case 10:  
  3.     addDiscountPercent(0); 
  4.     break; 
  5.   case 20:  
  6.     addDiscountPercent(2); 
  7.     break; 
  8.   case 30: 
  9.     addDiscountPercent(3); 
  10.     break; 
  11.   default:  
  12.     addDiscountPercent(0); 
  13.     break; 

13. 不要使用通配符导入

Fail:

  1. import * as Foo from './Foo'

Pass:

  1. import Foo from './Foo'

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

Fail:

  1. if (isValid === true
  2. if (isValid === false

Pass:

  1. if (isValid) 
  2. if (!isValid) 

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

Fail:

  1. const boo = a ? a : b; 

Pass:

  1. const boo = a || b; 

总结

任何语言的编码标准都可以真正帮助提高应用程序的可读性和可维护性。如果你在团队中工作,那么一件很难的事情就是强制执行编码标准。这里有一些建议可以帮助你:

  • 代码审查,逐行Pass代码。
  • 整理或使用某种代码分析器
  • 创建新内容时,让你们的一位高级开发人员初始化,其他开发人员可以使用该代码作为指导。

【编辑推荐】

  1. IBM为一个发布6年的工具招聘12年经验技术员引发社区群嘲
  2. GitHub 全球崩溃:数百万开发人员下班;国产Github呼声强烈
  3. JavaScript的解构技巧:排除对象属性、避免命名冲突、交换……
  4. 妥了!阿里程序员常用的 15 款开发者工具
  5. 警惕“JavaScript疲劳”:抱歉React,不能再紧跟你的步伐了
【责任编辑:华轩 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

订阅专栏+更多

大数据安全运维实战

大数据安全运维实战

CDH+Ambari
共20章 | 大数据陈浩

86人订阅学习

实操案例:Jenkins持续交付和持续部署

实操案例:Jenkins持续交付和持续部署

微服务架构下的自动化部署
共18章 | freshman411

174人订阅学习

思科交换网络安全指南

思科交换网络安全指南

安全才能无忧
共5章 | 思科小牛

107人订阅学习

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊

51CTO服务号

51CTO官微