搜文章
推荐 原创 视频 Java开发 iOS开发 前端开发 JavaScript开发 Android开发 PHP开发 数据库 开发工具 Python开发 Kotlin开发 Ruby开发 .NET开发 服务器运维 开放平台 架构师 大数据 云计算 人工智能 开发语言 其它开发
Lambda在线 > jscourse > [阅 #16] 写给初学者的 JavaScript 代码整洁之道

[阅 #16] 写给初学者的 JavaScript 代码整洁之道

jscourse 2017-10-30
「阅」——JSCourse 旗下栏目,专门推荐我们为大家精心挑选的优质 JavaScript 相关技术内容

每当你接手一个项目,看到其中别人写的代码的时候,是不是心情总能用下面这张很著名的漫画图来描述:




小编最近读到一篇来自  risingstack 的文章 ,讲了一些关于书写出整洁 JavaScript 代码的一些规范和最佳实践,我觉得对学习 JavaScript 的同学,特别是初学者应该有所帮助。我给大家挑选了几个典型的,加上我自己个人的经验,拿出来给大家分享一下:

到底应该如何给变量去名字?

世界上最难的事情之一就是给变量取名字了——我相信包括我在内几乎绝大部分工程师都认同这句话吧!那么到底应该如何给变量取名字呢?

我个人总结下来就一个成语 ——「顾名思义」,也就是变量名字一定要能够准确地表达意思。那么具体实施起来有几个建议:

  1. 不要担心名字会很长

  2. 避免不必要的单词出现

  3. 如果实在英文不是很好,词汇量少,查字典也无法解决问题,项目中只有中国人的话,用拼音我觉得也是可以的,也比用错单词好


光说不形象,我们来点例子:


[阅 #16] 写给初学者的 JavaScript 代码整洁之道



这样做的好处就是:

  1. 代码更加容易读懂

  2. 搜索起来更加容易


应该如何书写函数?

Uncle Bob 说过很著名的一句话:

Functions should do one thing. They should do it well. They should do it only.

说白了就是,函数要遵循「单一职责」模式。来看个例子:


[阅 #16] 写给初学者的 JavaScript 代码整洁之道



从上面这个例子中可以看到,这样做的好处不仅做了职责分离,各自专注自己的任务,而且对单元测试更友好。

函数参数列表不要太长

对于接收多个参数的函数,尽可能用一个对象来包含起来,不要一个一个传,就像这样:


[阅 #16] 写给初学者的 JavaScript 代码整洁之道



这样做的好处是扩展性更好,你想想要在中间增加一个参数的情况,第一种做法改起来就很麻烦,而且会修改参数签名。

不要在函数内部修改参数值

当函数接收某个数组或者对象为参数的时候,在内部不能修改该参数的值,因为这样会带来很多副作用,你压根不知道还有没有别的函数会使用这个参数,你改了就会影响其他用到这个参数的地方。来看个例子:


[阅 #16] 写给初学者的 JavaScript 代码整洁之道



遵循自上而下的准则来定义函数

如果一个文件中定义了多个函数,而且多个函数间会存在调用关系,那么这个时候应该遵循调用关系自上而下来定义函数。就像这样:



这样做的好处就是按照正常的阅读习惯和理解逻辑,更加便于阅读和理解代码。

每个人写 JavaScript 代码风格都不一样,应该怎么办?

这是客观事实,根据我个人的经验就是:除非整个项目就你一个人,否则都应该为项目或者团队,甚至全公司要建立编码规范并配合自动化校验工具(各种 lint 工具)来保证,同一个项目中不同人写出来的代码风格上都应该是统一的。

好了,本期就到这里,希望本期内容对你有所帮助!




版权声明:本站内容全部来自于腾讯微信公众号,属第三方自助推荐收录。《[阅 #16] 写给初学者的 JavaScript 代码整洁之道》的版权归原作者「jscourse」所有,文章言论观点不代表Lambda在线的观点, Lambda在线不承担任何法律责任。如需删除可联系QQ:516101458

文章来源: 阅读原文

相关阅读