有没有办法让javadoc工具记录注释？

Question

在我的项目中,我们使用了许多注释,这些注释在javadoc API文档中非常有用.

有谁知道在生成的javadocs中包含注释的简单方法？我不想写自己的javadoc插件.那里有解决方案吗？

Answer 1

请参阅java.lang.annotation.Documented

表示默认情况下,javadoc和类似工具将记录带有类型的注释.此类型应用于注释类型的声明,其注释会影响客户端对带注释元素的使用.如果使用Documented注释类型声明,则其注释将成为带注释元素的公共API的一部分.

例:

import java.lang.annotation.Documented;

@Documented
public @interface MyAnnotation {
}