@Documented 将此注解包含在 javadoc 中 ,它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。

这个注解只是用来标注生成javadoc的时候是否会被记录。

用法

在自定义注解的时候可以使用@Documented来进行标注,如果使用@Documented标注了,在生成javadoc的时候就会把@Documented注解给显示出来。

带@Documented生成的javadoc

不带@Documented生成的javadoc

这两个图的唯一差距就是类的说明是否有这个@API注解。

总结

@Documented注解只用来做文档输出标识