15.2 先写注释

我使用一种不同的方法来写注释，即在一开始就写注释：

• 对于一个新的类，我从写类的接口注释开始。

• 接下来，我为最重要的公共方法写接口注释和签名，但我把方法体留空。

• 我在这些注释上反复推敲，直到基本结构感觉正确为止。

• 这时，我开始为类中最重要的类实例变量写声明和注释。

• 最后，我填入方法的主体，并根据需要添加实现注释。

• 在写方法体的时候，我通常会发现需要额外的方法和实例变量。对于每一个新的方法，我都会在方法主体之前写上接口注释；对于实例变量，我在写变量声明的同时也会填上注释。

当代码完成后，注释也完成了。从来没有积压过未写的注释。

注释优先的方法有三个好处。首先，它能产生更好的注释。如果你在设计类的时候就写注释，那么关键的设计问题就会在你的脑海中浮现，所以很容易就能记录下来。最好是在写每个方法的主体之前写上接口注释，这样你就可以专注于方法的抽象和接口，而不会被它的实现分心。在编码和测试过程中，你会注意到并修复注释中的问题。因此，在开发过程中，注释会得到改善。