如何在运行时获取方法的 JavaDoc？

oop java runtime javadoc

2022-09-01 09:38:28

它在运行时很容易得到，
但是
我如何在运行时得到一个方法？a method NameClassJavaDoc

如以下示例所示

我们的类，包括我们的目标方法JavaDoc

public class MyClass {
    /**
     * 
     * @param x value of ....
     * @return result of ....
     */
    public String myMethod(int x) {
        return "any value";
    }

}

我们的类有一个主方法

public class TestJava {
    public static void main(String[] args) {
        // get Class method Name at run time
        String methodName = MyClass.class.getMethods()[0].getName();
        System.out.println(methodName); // will print myMethod
        // How to  get a JavaDoc of myMethod `method` at run time
        // MyClass.class.getMethods()[0].????
        // expected to print a JavaDoc of myMethod
    }
}

答案 1

在运行时获取它的唯一方法是使用自定义批注。

创建自定义注记类：

@Retention(RUNTIME)
@Target(value = METHOD)
public @interface ServiceDef {
  /**
   * This provides description when generating docs.
   */
  public String desc() default "";
  /**
   * This provides params when generating docs.
   */
  public String[] params();
}

在类的方法上使用它，例如：

@ServiceDef(desc = "This is an utility class",
            params = {"name - the name","format - the format"})     
public void read(String name, String format)

通过反射检查注释：

for (Method method : Sample.class.getMethods()) {
  if (Modifier.isPublic(method.getModifiers())) {
    ServiceDef serviceDef = method.getAnnotation(ServiceDef.class);
    if (serviceDef != null) {
      String[] params = serviceDef.params();
      String descOfMethod = serviceDef.desc();
    }
  }
}

答案 2

你不能：文件不包含注释。class

一个“解决方案”是在构建程序时将javadoc生成为HTML，并根据类的名称和方法的名称构建URL。您还可以使用 doclet API 以比 HTML 更合适的格式生成 javadoc。