@Documented
是一个元注释。您@Documented
在定义注释时应用,以确保使用注释的类在其生成的JavaDoc中显示此内容。我没有看到太多使用它,但是这里有一个例子。一个更早的问题表明它不能在Eclipse中自动运行,但是我已经在Eclipse 3.6中进行了测试,并且无论是否将@Documented
注释附加到JavaDoc弹出窗口中,我的注释都会出现。
这是Spring的示例,它确保在JavaDoc中将事务方法标记为:
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Transactional {