基于注释的JavaDoc

Question

我有一个类，其中包含类级变量的注释。在我的具体情况下，它是表示配置参数的 uimaFIT 注释，但为了简单起见，我们假设以下内容:

public class MyClass{
  @MyParameter(key="Foo", description="Example parameter")
  private String myVariable;

  //...rest of the class here
}

在我的 JavaDoc 中，我希望能够提取标有 @MyParameter 的变量，并在类页面上列出键和描述。 (原因是这些参数的值可以由用户注入(inject)，并且考虑到我已经在注释中为它们编写了描述，单独编写文档似乎毫无意义。)

输出可能如下所示，尽管只是将其放入其中就是一个开始!:

Foo - Example Parameter

这可能吗？如果需要的话，我不介意编写自己的类来“扩展”JavaDoc，但可以有人为我指明正确的方向!

Answer 1

我相信您正在寻找 doclet https://docs.oracle.com/javase/6/docs/technotes/guides/javadoc/doclet/overview.html它们允许您扩展 JavaDoc 功能。您可以编写自己的 doclet 并使用反射 api 来收集注释数据。