Làm thế nào để đọc ý kiến ​​Javadoc bằng cách phản ánh?

Question

Tôi cần phải biết làm thế nào để đọc comments Javadoc khi chạy

Nói rằng tôi có các chức năng sau đây (có lẽ do phản xạ?):

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

    //... 
} 

Khi chạy, tôi có thể nhận được nhiều thông tin về chức năng này bằng cách phản ánh .. Nhưng không thể đọc các bình luận. Vì vậy, câu hỏi là, Làm thế nào để đọc này javadoc ý kiến ​​khi chạy.

Answer 1

Cân nhắc sử dụng chú thích thay vì Javadoc và viết bộ xử lý chú thích.

Answer 2

Bạn không thể. Chúng bị xóa khỏi mã được biên dịch.

Answer 3

Bạn không thể làm điều đó, khiến javadoc không được biên dịch thành các lớp học cuối cùng.

Answer 4

Doclet lớp:

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

Và thực maven:

<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> 

đọc tài liệu từ classpath: META-INF/apidocs