轻松提高代码可读性，看完你也可以写出优秀代码！

轻松提高代码可读性，看完你也可以写出优秀代码！

注意:这篇文章是讲解代码可读性方面的一些写法优化,而不是指的性能优化。

下面是我总结的一份思维导图,方便形成对文章内容结构的一个大致的印象。

这节课的内容大纲

首先是关于代码优化的几条原则:

易读性优先

如果不是性能瓶颈问题,不要只是为了性能优化而改写代码

没有银弹。无论怎么写,代码的复杂性不会消失。

对于第三条，如果功能逻辑很简单，三言两语可以说清楚，那就肯定不需要几百行代码来完成，代码简简单单就可以完成了。如果你这个功能逻辑很复杂，10分钟内也没办法讲清楚的功能，那么代码也会体现出功能的复杂。

一、如何命名代码

程序员的三大难题

变量命名

缓存失效

循环边界

这里讲的是程序员的三大难题之一,变量命名。

包括两大点:

要注意词性。

注意一致性(风格统一)。

注意词性

普通变量

布尔变量命名,用「isX」或者「hasX」或者「canX」

函数变量

回调函数变量。用「介词」开头，或用「动词的现在完成时态」

这两种写法都很容易读,但是注意你最好只选择一种风格写法并保持,这也是下面将要提到的一致性。

特殊的情况 : 一些容易混淆的变量,可以添加前缀来让他们更容易读

特殊的情况 : 属性访问器函数,可以用名词

注意一致性(风格统一)

介词一致性

如果你使用了 before + after，那么就在代码的所有地方都坚持使用

如果你使用了 before + 完成时，那么就坚持使用

如果你改来改去，就「不一致」了，不一致将导致「不可预测」

顺序一致性

比如 updateContainerWidth 和 updateHeightOfContainer 的顺序就令人很别扭，同样会引发「不可预测」

表里一致性

函数名称正确的描述函数体内容,函数内容要体现函数名称，既不能多也不能少。

比如：

这就是表里不一，正确的写法是:

要么纠正函数名

要么写成两个函数

时间一致性

随着时间推移,业务的改变可能导致当初的变量名称已经不再合适,这时候要及时修改,这也是最难做到的,因为牵一发而动全身。

二、如何组织代码

现在我们的变量名称已经易读,容易理解了,之后干嘛?

是不是就剩下将你的变量组织起来了?

下面从两个经典的方法讲下如何组织你的代码

1.用函数优化你的代码

步骤：

将一坨代码放到一个函数里

将代码依赖的外部变量作为参数

将代码的输出作为函数的返回值

给函数取一个合适的名字

调用这个函数并传入参数

这个函数里的代码如果超过 5 行，则依然有优化的空间，请回到第 1 步

2.用对象组织你的代码

我们会用 this 来串联这个对象和所有函数。

还有一些需要注意的地方

一些固定套路

表驱动编程（《代码大全》里说的）

所有一一对应的关系都可以用表来做

自说明代码（以 API 参数为例）

把别人关心的东西放在显眼的位置

bad smell（坏味道）

有些代码可以用，但是很「臭」。

哪些代码是有坏味道的

表里不一的代码

过时的注释

逻辑很简单，但是看起来很复杂的代码

重复的代码

相似的代码

总是一起出现的代码

最后

做好了这几步，你的代码就可以变得更加优秀，可读性也大大提高起来。今天的前端开发工程师必备教程就讲到这里，大家如果要做开发，一定要做到一点：但凡是经过你手的代码，都会比之前好一点。

如果觉得有用，记得要关注点赞转发留言哦！

对于优化代码，你还有什么好方法吗？快留言分享下呗！