How to get a JavaDoc of a method at run time?

by

The only way to get it at runtime is to use custom annotations.

Create a custom annotation class:

@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();
}

Use it on a method of a class, e.g.:

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

Inspect the annotations via reflection:

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();
    }
  }
}

More Related Contents:

  1. How do i get an object from another class in java
  2. What is the impact of declaring a method as final?
  3. Java polymorphism error? [closed]
  4. Method Overloading for null argument
  5. Remove Top-Level Container on Runtime
  6. Can we instantiate an abstract class?
  7. Why use getters and setters/accessors?
  8. Should we @Override an interface’s method implementation?
  9. read the output from java exec
  10. Encapsulation vs Abstraction?
  11. List of useful environment settings in Java
  12. Replacing if else statement with pattern
  13. Java `final` method: what does it promise?
  14. How to generate Javadoc HTML files in Eclipse?
  15. How to quickly determine if a method is overridden in Java
  16. Using Command Design pattern
  17. What is method hiding in Java? Even the JavaDoc explanation is confusing
  18. Static Binding and Dynamic Binding
  19. What is the purpose of Serialization in Java?
  20. Difference Between Object Type and Reference Type
  21. Where is the “server log” for Tomcat when running externally from IntelliJ Ultimate?
  22. Runtime.exec on argument containing multiple spaces
  23. Should you always Code To Interfaces In Java [closed]
  24. Access subclass fields from a base class in Java
  25. Obtain and download Javadoc (JDK documentation) to a local file for offline reading
  26. interface as a method parameter in Java
  27. How to make generated classes contain Javadoc from XML Schema documentation
  28. How do I exclude a specific method/constructor from the results of the javadoc Ant task?
  29. How configure Intellij Idea javadoc templates?
  30. They say in java “every thing is an object”. Is that true?

Leave a Comment