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

Question

在我的项目中，我们使用了一些注释，这些注释在 javadoc API 文档中非常有用。

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

Answer 1

请参阅java.lang.annotation.Documented

表示默认情况下，带有类型的注释将由 javadoc 和类似工具记录。这种类型应该用于注释类型的声明，这些类型的注释会影响其客户对注释元素的使用。如果使用 Documented 对类型声明进行注释，则其注释将成为注释元素的公共 API 的一部分。

例子：

import java.lang.annotation.Documented;

@Documented
public @interface MyAnnotation {
}