首页 存档 技术 查看内容

JavaScript 代码整洁之道(上)

2018-3-30 13:00 |来自: 互联网 314 0

摘要: 目录 概述 变量 函数 对象和数据结构 类 测试 并发 错误处理 格式 注释 概述 Robert C. Martin 在《代码整洁之道》中提到的软件工程原则,同样适用于 JavaScript。这不是一个风格参考。它指导如何用 JavaScript ...

目录

  1. 概述

  2. 变量

  3. 函数

  4. 对象和数据结构

  5. 测试

  6. 并发

  7. 错误处理

  8. 格式

  9. 注释

概述

Robert C. Martin 在《代码整洁之道》中提到的软件工程原则,同样适用于 JavaScript。这不是一个风格参考。它指导如何用 JavaScript 编写可读、可复用、可重构的软件。

并不是每一个原则都必须严格遵循,甚至很少得到大家的认同。它们仅用于参考,不过要知道这些原则都是《代码整洁之道》的作者们累积多年的集体经验。

我们在软件工程方面的技术发展刚刚超过 50 年,我们仍然在学习很多东西。当软件架构和架构本身一样古老的时候,我们应该遵循更为严格规则。现在,对于你和你的团队编写的 JavaScript 代码,不妨依据这些准则来进行质量评估。

还有一件事:知道这些不会马上让你成为更好的软件开发者,在工作中常年使用这些准则不能让你避免错误。每一段代码都从最初的草图开始到最终成型,就像为湿粘土塑形一样。最后,当我们与同行一起审查的时候,再把不完美的地方消除掉。不要因为初稿需要改善而否定自己,需要要否定的只是那些代码!

变量

使用有准确意义的变更名

不好:

var yyyymmdstr = moment().format('YYYY/MM/DD');

:

var yearMonthDay = moment().format('YYYY/MM/DD');

在变量的值不会改变时使用 ES6 的常量

在不好的示例中,变量可以被改变。如果你申明一个常量,它会在整个程序中始终保持不变。

不好:

var FIRST_US_PRESIDENT = "George Washington";

:

const FIRST_US_PRESIDENT = "George Washington";

对同一类型的变量使用相同的词汇

不好:

getUserInfo();
getClientData();
getCustomerRecord();

:

getUser();

使用可检索的名称

我们阅读的代码永远比写的折。写可读性强、易于检索的的代码非常重要。在程序中使用明确意义的变量名会难以理解,对读者造成伤害。所以,把名称定义成可检索的。

不好:

// 见鬼,525600 是个啥?
for (var i = 0; i
声明:文章版权归原作者所有 部分文章转自互联网 如有侵权请联系 [邮箱地址] 删除

路过

雷人

握手

鲜花

鸡蛋

相关分类

返回顶部