什么是整洁的代码?

在软件工程这样一个庞大而多样化的领域中，持续阅读对于构件基础知识和探索分支知识至关重要。与任何行业一样，软件开发有一些必读书籍，而《代码整洁之道》就是其中之一。这本书常年出现在Google的“顶级软件工程书籍”搜索结果中，并且在工程界广为人知。

这里有一些我从中学习到的知识，与大家分享一下。

对这本书的介绍

image

在很多方面，《代码整洁之道》的结构像是一本代码手册。正如大多数好书一样，是一本非常自以为是的书。

作者马丁在这本书中描述了什么是好的编码以及怎样去重构不好的编码，以告诫那些无法分辨出编码习惯好坏的人。马丁对他的失败持开放态度。多年来阅读糟糕的代码的经历让他有意去帮助其他开发者避免危险。总之，这本书成百上千的建议会使你生产出优质的代码。也就是说，大多数工程师都在努力学习，使他的糟糕的代码变得更好。

但是《代码整洁之道》不仅仅是一个教程。他不仅描述了编写好代码的方式，而且写了为什么要写好代码。不仅仅是事记硬背的规则。我从中读出了一个优秀的程序员的不可侵犯的价值观。下面，我将这概括为三个关键的概念。

1. 我们要有工匠精神

很少会有那种从始到终都不被修改的完美代码(当然，“完美的代码”这样的说法是错误的，没有什么事物是完美的)。尽管如此，编写出尽可能最好的代码是软件工程师的首要任务。有的时候，这意味着我们要在项目进度、客户需求、管理要求、疲劳这几方面进行平衡。

底线：“工作”的代码并不总是“完成”。如果编码人员的工作是生产解决问题的产品，那么解决问题的方法是否重要？是。从长远来看，软件做得很好，每个人都受益，包括客户，用户，公司和编码员。代码混乱，匆忙或“足够好”的代码，这是着眼于短期回报的体现。

即使是优秀整洁的代码，在一段时间过后也会显得糟糕不堪。而且会比你预想中的要坏。

马丁认为，编写整洁的代码的关键是高质量的输入（周全，可维护，灵活的代码），可以产生高质量的输出（长期业务收益）。

2. 你今天的努力可以减轻日后的负担

我们所有人都经历过使用低质量产品所带来的失望。想象一下，在洗衣机中几分钟就会磨损边缘的新衬衫，或者是在你的孩子将它从包装盒中取出后立即打破的塑料玩具。制作精良的代码也是这样，它在边缘处的碎片速度比您预期的要快得多。(所以我们需要边界值测试)

你可以试着跟一些质量很好的东西进行比较。有一双鞋我每天都穿，并且穿了十年，这几天终于破了。这双鞋比其他鞋子贵一点，但它的质量是不可否认的，从长远来看，我省钱了。当时间终于把这些鞋扔出去时，我又买了一双相同的对，因为我知道这双鞋又会陪伴我十年。

同样的原则适用于代码。高质量的输入不仅可以产生更持久的输出，还可以节省资金并建立客户忠诚度。精心重构和测试您的代码可能需要更长的时间，但技术债务和可维护性的节省非常值得额外的努力。

3. 你的代码不只是你自己的

以自己的工作为荣，这很重要。认识到你编写的代码不是你自己的代码同样重要。

过于聪明的技巧，黑客和程序手的技巧只对作者有趣。

这可能看起来有点悖论 - 毕竟，编写干净的代码需要您与其质量相媲美。但好的代码并不是真的，因为它的目的是供他人使用：你的队友，你的客户，甚至你未来的自我。当一些未来的项目维护者（甚至可能是你自己）无法理解为什么你用你的方式写东西时会发生什么？毫无疑问，他们必须花费宝贵的时间和精力来解读你为他们留下的谜题。