编写可读的代码

来源:《程序员

代码最重要的读者不再是编译器、解释器或者电脑,而是人。写出的代码能让人易于理解、轻松维护、容易扩展的程序员才是专业的程序员。

代码应当易于理解

在过去的五年里,我们收集了上百个“坏代码”的例子(其中很大一部分是我们自己写的),并且分析是什么原因使它们变坏,使用什么样的原则和技术可以让它们变好。我们发现所有的原则都源自同一个主题思想。

关键思想:代码应当易于理解

我们相信这是当你考虑要如何写代码时可以使用的最重要的指导原则。我们会展示如何把这条原则应用于你每天编码工作的各个不同方面。但在开始之前,我们会详细地介绍这条原则并证明它为什么这么重要。

编写可读的代码

是什么让代码变得“更好”

大多数程序员(包括两位作者)依靠直觉和灵感来决定如何编程。我们都知道这样的代码:

比下面的代码好:

(尽管两个例子的行为完全相同。)但很多时候这个选择会更艰难。例如,这段代码:

它比下面这段要好些还是差些?

第一个版本更紧凑,但第二个版本更直白。哪个标准更重要呢?一般情况下,在写代码时你如何来选择?

可读性基本定理

在对很多这样的例子进行研究后,我们总结出,有一种对可读性的度量比其他任何的度量都要重要。因为它是如此重要,我们把它叫做“可读性基本定理”。

关键思想:代码的写法应当使别人理解它所需的时间最小化。

这是什么意思?其实很直接,如果你叫一个普通的同事过来,测算一下他通读你的代码并理解它所需的时间,这个“理解代码时间”就是你要最小化的理论度量。

并且当我们说“理解”时,我们对这个词有个很高的标准。如果有人真的完全理解了你的代码,他就应该能改动它、找出缺陷并且明白它是如何与你代码的其他部分交互的。

现在,你可能会想:“谁会关心是不是有人能理解它?我是唯一使用这段代码的人!”就算你从事只有一个人的项目,这个目标也是值得的。那个“其他人”可能就是 6 个月的你自己,那时你自己的代码看上去已经很陌生了。而且你永远也不会知道——说不定别人会加入你的项目,或者你“丢弃的代码”会在其他项目里重用。

总是越小越好吗

一般来讲,你解决问题所用的代码越少就越好。很可能理解 2000 行代码写成的类所需的时间比 5000 行的类要短。但少的代码并不总是更好!很多时候,像下面这样的一行表达式:

理解起来要比两行代码花更多时间:

类似地,一条注释可以让你更快地理解代码,尽管它给代码增加了长度:

因此尽管减少代码行数是一个好目标,但把理解代码所需的时间最小化是一个更好的目标。

理解代码所需的时间是否与其他目标有冲突

你可能在想:“那么其他约束呢?像是使代码更有效率,或者有好的架构,或者容易测试等?这些不会在有些时候与使代码容易理解这个目标冲突吗?”我们发现这些其他目标根本就不会互相影响。就算是在需要高度优化代码的领域,还是有办法能让代码同时可读性更高。并且让你的代码容易理解往往会把它引向好的架构且容易测试。有些程序员对于任何没有完美地分解的代码都不自觉地想要修正它。这时很重要的是要停下来并且想一下:“这段代码容易理解吗?”如果容易,可能转而关注其他代码是没有问题的。

最难的部分

是的,要经常地想一想其他人是不是会觉得你的代码容易理解,这需要额外的时间。这样做就需要你打开大脑中从前在编码时可能没有打开的那部分功能。但如果你接受了这个目标(像我们一样),我们可以肯定你会成为一个更好的程序员,会产生更少的缺陷,从工作中获得更多的自豪,并且编写出你周围人都爱用的代码。

本文节选自《编写可读代码的艺术》一书,Dustin Boswell、Trevor Foucher 著,尹哲、郑秀雯译,由机械工业出版社出版。

 

1 收藏 评论

相关文章

可能感兴趣的话题



直接登录
跳到底部
返回顶部