@Documented是Java中的一个元注解,用于指定注解是否包含在生成的Java文档中。当一个注解被@Documented元注解标记时,它的信息将会被包含在生成的API文档中,使得注解的信息能够被开发者所见。
通常情况下,生成的Java文档(JavaDoc)中只包含类、接口、方法等元素的文档注释,而注解的信息默认是不会在文档中显示的。然而,当我们希望注解的信息也能够被文档化并对其他开发者可见时,就可以使用@Documented元注解。
以下是一个示例,展示如何使用@Documented元注解:
在上述示例中,@MyAnnotation注解被@Documented元注解标记,因此在生成的API文档中会包含该注解的说明和使用方法。
需要注意的是,@Documented元注解仅仅影响注解本身是否在文档中可见,并不会影响注解所标记的代码元素(类、方法等)是否在文档中可见。要使得注解所标记的代码元素在文档中可见,需要在注解所标记的元素上添加合适的文档注释。
网友评论