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
到此这篇关于15个简单的JS编码标准让你的代码更整洁(小结)的文章就介绍到这了,更多相关JS编码标准内容请搜索猪先飞以前的文章或继续浏览下面的相关文章希望大家以后多多支持猪先飞!
相关文章
- 本篇文章主要分享了通过window.navigator来判断浏览器及其版本信息的实例代码。具有一定的参考价值,下面跟着小编一起来看下吧...2017-01-23
- 这篇文章主要介绍了js如何实现浏览器打印功能,文中示例代码非常详细,帮助大家更好的理解和学习,感兴趣的朋友可以了解下...2020-07-15
- 这篇文章主要给大家介绍了关于Nest.js参数校验和自定义返回数据格式的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-03-28
- 下面小编就为大家带来一篇利用JS实现点击按钮后图片自动切换的简单方法。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧...2016-10-25
- 这篇文章主要介绍了js实现调用网络摄像头及常见错误处理,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧...2021-03-07
- 这篇文章主要为大家详细介绍了JS实现随机生成验证码,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2021-09-06
- 作为前端,一直以来都知道HTTP劫持与XSS跨站脚本、CSRF跨站请求伪造。防御这些劫持最好的方法是从后端入手,前端能做的太少。而且由于源码的暴露,攻击者很容易绕过防御手段。但这不代表我们去了解这块的相关知识是没意义的,本文的许多方法,用在其他方面也是大有作用。...2021-05-24
- 这篇文章主要介绍了js组件SlotMachine实现图片切换效果制作抽奖系统的相关资料,需要的朋友可以参考下...2016-04-19
- 这篇文章主要介绍了基于JavaScript实现文字超出部分隐藏 的相关资料,需要的朋友可以参考下...2016-03-01
- 这篇文章主要为大家详细介绍了js实现列表按字母排序,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2020-08-11
- 本文给大家介绍的是nodejs实现使用阿里大鱼短信API发送消息的方法和代码,有需要的小伙伴可以参考下。...2016-01-20
- 这篇文章主要介绍了JS实现响应鼠标点击动画渐变弹出层效果代码,具有非常自然流畅的动画过度效果,涉及JavaScript针对鼠标事件的响应及页面元素样式的动态操作相关技巧,需要的朋友可以参考下...2016-03-28
- Vue.js通过简洁的API提供高效的数据绑定和灵活的组件系统.这篇文章主要介绍了vue.js 表格分页ajax 异步加载数据的相关资料,需要的朋友可以参考下...2016-10-20
- 这次文章要给大家介绍的是node.JS md5加密中文与php结果不一致怎么办,不知道具体解决办法的下面跟小编一起来看看。 因项目需要,需要Node.js与PHP做接口调用,发现nod...2017-07-06
- 系统的学习了一下angularjs,发现angularjs的有些思想根php的模块smarty很像,例如数据绑定,filter。如果对smarty比较熟悉的话,学习angularjs会比较容易一点,这篇文章给大家介绍angularjs filter用法详解,感兴趣的朋友一起学习吧...2015-12-29
- 这篇文章主要为大家详细介绍了js实现上传图片及时预览的相关资料,具有一定的参考价值,感兴趣的朋友可以参考一下...2016-05-09
- 为了网站的安全性,很多朋友都把密码设的比较复杂,但是如何密码不能明显示,不知道输的是对是错,为了安全起见可以把密码显示的,那么基于js代码如何实现的呢?下面通过本文给大家介绍JavaScript实现表单密码的隐藏和显示,需要的朋友参考下...2016-03-03
- v-for标签可以用来遍历数组,将数组的每一个值绑定到相应的视图元素中去,下面这篇文章主要给大家介绍了关于在Vue.js中轻松解决v-for执行出错的三个方案,文中通过示例代码介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面来一起看看吧。...2017-06-15
- 使用require('crypto')调用加密模块。加密模块需要底层系统提供OpenSSL的支持。它提供了一种安全凭证的封装方式,可以用于HTTPS安全网络以及普通HTTP连接。该模块还提供了一套针对OpenSSL的hash(哈希),hmac(密钥哈希),cipher...2014-06-07
- 这篇文章主要教大家如何利用Bootstrap3制作图片轮播效果,具有一定的参考价值,感兴趣的小伙伴们可以参考一下...2016-05-14