Module java.base

Annotation Interface Documented


@Documented @Retention(RUNTIME) @Target(ANNOTATION_TYPE) public @interface Documented
如果在注解接口A的声明上存在注解@Documented,那么元素上的任何@A注解都被视为元素的公共契约的一部分。更详细地说,当注解接口A被注解为Documented时,A注解的存在和值是元素A的公共契约的一部分。相反,如果注解接口B没有被注解为Documented,那么B注解的存在和值不是元素B的公共契约的一部分。具体来说,如果一个注解接口被注解为Documented,那么像javadoc这样的工具默认会在输出中显示该接口的注解,而没有被注解为Documented的注解接口的注解将不会被显示。
自版本:
1.5