Module  java.base
软件包  java.lang.annotation

Annotation Type 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