15.1 迟到的注释不是好注释

几乎所有我见过的开发者都会推迟写注释。当被问及为什么不早点写文档时，他们说，代码还在变化。他们说，如果他们早点写文档，当代码发生变化时，他们就必须重写；最好是等到代码稳定下来。然而，我怀疑还有另一个原因，那就是他们认为文档是苦差事；因此，他们尽可能地拖延。

不幸的是，这种做法有几个负面的后果。首先，拖延文档往往意味着它根本就没有被写出来。一旦你开始拖延，就很容易再拖延下去；毕竟，再过几周，代码就会更加稳定了。等到代码无可争辩地稳定下来的时候，代码已经很多了，这意味着写文档的任务已经变得很庞大，甚至更加没有吸引力了。从来没有一个方便的时间可以停下来几天，把所有缺失的注释补上，而且很容易辩解说，对项目来说最好的事情是继续前进，修复bug或编写下一个新功能。这将会产生更多的无文档的代码。

即使你能自律地回去写注释（不要自欺欺人：你可能没有），这些注释也不会很好。在这个过程中，你已经在精神上退出了。在你的脑海中，这段代码已经完成了；你急于进入下一个项目。你知道写注释是正确的事情，但这并不有趣。你只想尽可能快地完成它。因此，你快速浏览了一遍代码，添加了足够多的注释，使其看起来很体面。现在，距离你设计这段代码已经有一段时间了，所以你对设计过程的记忆也变得模糊了。你在写注释的时候看了看代码，所以注释就会重复代码。即使你试图重构那些从代码中看不出来的设计思想，也会有一些你不记得的东西。因此，注释中缺少了一些它们应当描述的最重要的东西。