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

Question

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

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

标签： javaclassmethodscopy

Answer 1

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

例如，假设你的类有一个User getUser(int id)方法。还假设您的课程在 package 中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

javadoc如果您需要做任何更有趣的事情，这里是带有进一步说明的手册。这里有一些关于如何最好地编写文档的建议（过时了，但仍然很好）。