java - 获取Java中方法的@param注释

Question

有没有办法获取Java中方法的@param注释？我知道通过解析每个java文件可以很容易地实现这一点。然而，这似乎应该已经在 J​​avaCC 这样的工具中可用。

示例 - 我希望能够读取 ch 和观察者:

* @param ch        the character to be tested
* @param observer  the image observer to be notified

Answer 1

如果您有来源，您可能会考虑使用QDox它被描述为一个高速、占用空间小的解析器，用于从带有 JavaDoc @tags 的源文件中提取类/接口(interface)/方法定义。它旨在供主动代码生成器或文档工具使用。

示例代码from documentation :

JavaMethod mth = cls.getMethods()[0];

// Access the JavaDoc comment
String comment = mth.getComment();
  // "This method does nothing at all."

// Access a single doclet tag
DocletTag returns = mth.getTagByName("returns");
returns.getName(); // "returns";
returns.getValue(); // "A boolean of whether we care or not."

// Access multiple doclet tags with the same name
DocletTag[] params = mth.getTagsByName("param");
params[0].getValue(); // "Someone's email address."
params[1].getValue(); // "Date of birth."

// Access specific parameters of a doclet tag by index
DocletTag permission = mth.getTagByName("permission");
permission.getParameter[0]; // "administrator"
permission.getParameter[1]; // "full-access"

// Access specific parameters of a doclet tag by name
DocletTag webservice = mth.getTagByName("webservice");
webservice.getNamedParameter("type"); // "rpc"
webservice.getNamedParameter("name"); // "myservice"