¿Cómo leer los comentarios de Javadoc por reflexión?

Question

Necesito saber cómo leer los comentarios Javadoc en tiempo de ejecución

Digamos que tiene la siguiente función (probablemente por la reflexión?):

/** 
* function that do some thing 
*/ 
public void myFunc() 
{ 

    //... 
} 

En tiempo de ejecución, puedo obtener mucha información acerca de esta función por reflexión ... Pero no puedo leer los comentarios. Entonces la pregunta es, ¿Cómo leer esto javadoc comentarios en tiempo de ejecución.

Answer 1

Considere utilizar anotaciones en lugar de Javadoc y escriba un procesador de anotación.

Answer 2

No puede. Se eliminan del código compilado.

Answer 3

No puede hacer eso, porque javadoc no está compilado en las clases finales.

Answer 4

Doclet clase:

public class ExtractCommentsDoclet { 
    public static boolean start(RootDoc root) throws IOException { 
     for (ClassDoc c : root.classes()) { 
      print(c.qualifiedName(), c.commentText()); 
      for (FieldDoc f : c.fields(false)) { 
       print(f.qualifiedName(), f.commentText()); 
      } 
      for (MethodDoc m : c.methods(false)) { 
       print(m.qualifiedName(), m.commentText()); 
       if (m.commentText() != null && m.commentText().length() > 0) { 
        for (ParamTag p : m.paramTags()) 
         print(m.qualifiedName() + "@" + p.parameterName(), p.parameterComment()); 
        for (Tag t : m.tags("return")) { 
         if (t.text() != null && t.text().length() > 0) 
          print(m.qualifiedName() + "@return", t.text()); 
        } 
       } 
      } 
     } 
     return true; 
    } 

    private static void print(String name, String comment) throws IOException { 
     if (comment != null && comment.length() > 0) { 
      new FileWriter(name + ".txt").append(comment).close(); 
     } 
    } 
} 

y ejecución experta:

<plugin> 
    <artifactId>maven-javadoc-plugin</artifactId> 
    <extensions>true</extensions> 
    <executions> 
     <execution> 
      <phase>compile</phase> 
      <goals> 
       <goal>aggregate</goal> 
      </goals> 
     </execution> 
    </executions> 
    <configuration> 
     <doclet>ExtractCommentsDoclet</doclet> 
     <docletPath>${project.build.directory}/classes</docletPath> 
     <reportOutputDirectory>${project.build.outputDirectory}/META-INF</reportOutputDirectory> 
     <useStandardDocletOptions>false</useStandardDocletOptions> 
    </configuration> 
</plugin> 

Leer documentos de ruta de clases: META-INF/apidocs