java - 如何将方法签名从一个类复制到一个文件？

Question

我有一个 Java 类，其中包含可在框架的其他部分中重用的所有方法。有很多。由于公司政策，我对此无能为力。

我想将从该类中以“public”开头的所有行复制到文件或另一个类中。只是为了拥有方法签名以便更轻松地搜索特定功能。这些方法正在被添加、删除，所以也许有一种复制所有这些方法的方法，可以在我需要时手动启动？也许正则表达式可以提供帮助，但我不知道如何处理它。

Answer 1

您可以使用 javadoc 为您生成文档，前提是您将 javadoc 注释添加到您的方法中。

例如，假设您的类有一个 User getUser(int id) 方法。另外假设您的类位于包 com.example.myproject 中。在方法定义之前，您应该添加类似这样的内容

/**
 * Returns a user given an id
 *
 * @param  id   the id the User has on database
 * @return      An instance of <code>User</code> corresponding to the given id
 */
 public User getUser(int userId) {

请注意，注释以 /** 开头，而不是以 /* 开头。

完成后，您可以调用 javadoc 为您的包生成文档 html。

javadoc com.example.yourproject

Here是 javadoc 的手册，如果您需要做任何更奇特的事情，其中​​包含进一步的说明。和here关于如何最好地编写文档的一些建议(过时，但仍然很好)。