简介

image.png

源自 Robert C. Martin 的 Clean Code 将原则适配到 JavaScript 。

这不是一个代码风格指南, 它是一个使用 JavaScript 来生产可读的, 可重用的, 以及可重构的软件的指南。

这里的每一项原则都不是必须遵守的。

Tip: 每一段代码最开始都是草稿, 像湿粘土一样被打造成最终的形态。 当我们审查代码时清除那些不完善之处, 这是一项正常的优化操作,不需要为最初的草稿粗糙而自责。我们只需要,尽量的保持草稿的‘精致’

变量

使用有意义并且可读的变量名称

不好的:

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

好的:

const currentDate = moment().format('YYYY/MM/DD');

为相同类型的变量使用相同的词汇

不好的:

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

好的:

getUser();

使用可搜索的名称

我们要阅读的代码比要写的代码多得多, 所以我们写出的代码的可读性和可搜索性是很重要的。 使用没有 意义的变量名将会导致我们的程序难于理解, 将会伤害我们的读者, 所以请使用可搜索的变量名。 类似 buddy.jsESLint 的工具可以帮助我们找到未命名的常量。