能把代码写出来是一回事,但是写出整洁、可读的代码又是另一回事。然而,什么是「干净的代码」呢?怎么才能写出「干净的代码」?为了解答这些问题,本文作者写了一份针对开发者的干净代码指南。 不妨想象一下,你正在阅读一篇文章,文章开头段简要概述了文章的内容。文中还有一些小标题,它们会引出各部分的段落。段落是通过将相关信息按照合理的顺序组合起来而构成的,这样文章就会变得「行云流水」,可读性很强。

现在,你可以反过来再想象一下如果这篇文章没有任何小标题。文中只有很多小段落,它们十分冗长并杂乱无章。那么你就无法快速浏览这篇文章,必须真正深入到内容中去,这样才能对整篇文章有大概的了解。这确实会带来很差的阅读体验!

你的代码应该像一篇美文一样,需要给读者带来很好的阅读体验。将你代码的类/文件视为文章的小标题,将你的方法(函数)视为文章的段落。你代码中的语句就相当于文章中的句子。下面本文将列出一些干净代码的特征:

干净的代码是专一的:每个函数、类和模块都应该只做一件事,并且将其做好。

干净代码应该是优雅的:干净的代码应该易于阅读,阅读干净的代码会让你感到愉悦,它应该让你认为「我确实知道这里的代码在做什么」。

干净代码应该经常维护:我们需要花时间让它保持简单有序,并适当关注代码的细节。

干净代码应该通过各种测试:会崩溃的代码肯定不是干净的!

那么现在主要的问题就是,作为一个开发者,你如何才能编写出干净的代码?下面是一些实用的小建议。