个人项目中干净代码的重要性

你可能认为,对于个人项目来说,代码整洁并不那么重要。如果你这样想,那就大错特错了,原因有很多,在此一一列举:

  • 你怎么能保证将来不会有人参与开发?

  • 如果你将自己的项目开放源代码,难道你不想让全世界都看到你的编码是干净的,并以此为荣吗?

  • 你可能希望反复改进你的项目。如果你编写的基础很差,那么维护和添加新内容将是一场噩梦,而不用担心会破坏任何东西。有时,由于代码编写得不好,根本无法添加新功能。在最糟糕的情况下,你将不得不完全重写应用程序。你可不想这么做。

如前所述,试着阅读一下你几年前编写的代码。你很有可能无法简单理解你当时想做什么。你可能会认为你写的注释(如果你这样做的话)是来帮助你的,但让我们提出以下两个问题:

  • 谁会真正阅读代码注释?

  • 如果写代码时不需要注释,而且写得非常清楚,可以像一本书一样阅读,那该怎么办?

这就是它的意义所在:能够像阅读简单句子一样阅读源代码,而不必为了理解一行代码而停下来。另外,我想重复一下关于团队中的简洁代码的说法:你独自创建一个项目并不意味着你不需要外部帮助。事实上,几乎可以肯定的是,总有一天你会需要别人的帮助。同样,如果你们有一套共同的规则,那么帮助者就会更容易提出他们的想法。即使在个人时刻和项目中,开发人员的工作也是团队合作。始终如一。

整洁的代码是一种心态,这种心态包括为我们所创造的东西感到自豪—​一种工作出色完成的滋味。也许需要几年的时间才能完全理解它的含义,我们总是有新的东西要学,有第一次面对的情况。所谓 "代码整洁",就是当你看到自己的代码时,告诉自己完全可以放心地向任何人展示自己的代码。

俗话说,"写代码时要让下一个运行它的开发人员知道你的意图"。这同样适用于个人项目,因为你就是下一个开发者。

总结

理论讲完了吗?算是吧。我们共同定义了简洁代码的内涵。我们共同给出了简洁代码的定义。有了对清洁代码的共同定义,我们对它的理解就更深了一步,可以在下一节深入探讨更高级的原则了。

当然,我们还没有结束。即使你同意我们提出的定义,你也可能已经有了很多疑问。最重要的问题应该是以下几个:谁为你们决定这些规则?谁有权力强加这一愿景?这就是我们将在下一章共同探讨的问题。