Tiger 中的注释，第 2 部分: 定制注释

核心提示： 设置继承最后一个元注释 Inherited ，可能是最复杂、使用最少、也最容易造成混淆的一个，Tiger 中的注释，第 2 部分: 定制注释(8)，这就是说，我们简单地看一看就可以了，无论如何，注释都是一种很好的工具， 首先考虑这样一种情况：假设您通过定制的 InProgress 注释标记一个类

设置继承

最后一个元注释 Inherited ，可能是最复杂、使用最少、也最容易造成混淆的一个。这就是说，我们简单地看一看就可以了。

首先考虑这样一种情况：假设您通过定制的 InProgress 注释标记一个类正在开发之中，这完全没有问题，对吧？这些信息还会出现在 Javadoc 中，只要您正确地应用了 Documented 元注释。现在，假设您要编写一个新类，扩展那个还在开发之中的类，也不难，是不是？但是要记住，那个超类还在开发之中。如果您使用子类，或者查看它的文档，根本没有线索表明还有什么地方没有完成。您本来希望看到 InProgress 注释被带到子类中 —— 因为这是 继承 的 —— 但情况并非如此。您必须使用 Inherited 元注释说明所期望的行为，如清单 14 所示：

清单 14. 使用 Inherited 元注释
package　com.oreilly.tiger.ch06;　
import　java.lang.annotation.Documented;　
import　java.lang.annotation.Inherited;　
import　java.lang.annotation.Retention;　
import　java.lang.annotation.RetentionPolicy;　
/**　
　*　Marker　annotation　to　indicate　that　a　method　or　class　
　*　　is　still　in　progress.　
　*/　
@Documented　
　　　　@Inherited　
@Retention(RetentionPolicy.RUNTIME)　
public　@interface　InProgress　{　}　

添加 @Inherited 后，您将看到 InProgress 出现在注释类的子类中。当然，您并不希望所有的注释类型都具有这种行为（因此默认值是 不 继承的）。比如， TODO 注释就不会（也不应该）被传播。但是对于这里示范的情况， Inherited 可能非常有用。

结束语

现在，您也许已经准备回到 Java 世界为所有的事物编写文档和注释了。这不禁令我回想起人们了解 Javadoc 之后发生的事情。我们都陷入了文档过滥的泥潭，直到有人认识到最好使用 Javadoc 来理清容易混淆的类或者方法。无论用 Javadoc 做了多少文章，也没有人会去看那些易于理解的 getXXX() 和 setXXX() 方法。

注释也可能出现同样的趋势，虽然不一定到那种程度。经常甚至频繁地使用标准注释类型是一种较好的做法。所有的 Java 5 编译器都支持它们，它们的行为也很容易理解。但是，如果要使用定制注释和元注释，那么就很难保证花费很大力气创建的那些类型在您的开发环境之外还有什么意义。因此要慎重。在合理的情况下使用注释，不要荒谬使用。无论如何，注释都是一种很好的工具，可以在开发过程中提供真正的帮助。