@Documented 将此注解包含在 javadoc 中 ,它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。
这个注解只是用来标注生成javadoc的时候是否会被记录。
用法
在自定义注解的时候可以使用@Documented来进行标注,如果使用@Documented标注了,在生成javadoc的时候就会把@Documented注解给显示出来。
带@Documented生成的javadoc
不带@Documented生成的javadoc
这两个图的唯一差距就是类的说明是否有这个@API注解。
总结
@Documented注解只用来做文档输出标识
发表评论
2022-04-09 14:22:51回复
2022-04-09 14:22:44回复
2022-04-09 14:22:28回复
2022-04-09 14:22:08回复
不带@Documented生成的javadoc
2022-04-09 14:22:02回复
不带@Documented生成的javadoc
2022-04-09 14:21:44回复
2022-04-09 14:21:27回复
2022-04-09 14:21:08回复
2022-04-09 14:21:00回复
2022-04-09 14:20:46回复
2022-04-09 14:20:29回复
2022-04-09 14:20:20回复
2022-04-06 10:22:03回复
2022-04-06 10:21:39回复
2022-04-06 10:20:52回复
2022-04-06 10:20:23回复
(1)document:生成API帮助文档时显示注解。
(2)Retention:会被jvm保留。
(3)Target:是元注解。
2022-04-06 10:20:07回复
被Documented修饰的注解A(假设A,有点拗口),然后使用注解A去修饰某个类B(假设B,也可以是方法或者属性),在使用javadoc(不明白找度娘,或者继续向下看)命令将B生成API帮助文档时,将会把注解信息也显示在此文档中。
2022-04-06 10:17:29回复
2022-04-06 10:16:57回复
@Documented 注解表明这个注解应该被 javadoc工具记录. 默认情况下,javadoc是不包括注解的. 但如果声明注解时指定了 @Documented,则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中,是一个标记注解,没有成员。
2022-04-06 10:16:18回复
2022-04-06 10:15:40回复
@Documented 注解表明这个注解应该被 javadoc工具记录. 默认情况下,javadoc是不包括注解的. 但如果声明注解时指定了 @Documented,则它会被 javadoc 之类的工具处理, 所以注解类型信息也会被包括在生成的文档中,是一个标记注解,没有成员。