web-dev-qa-db-ja.com

リフレクションによってJavadocコメントを読む方法は？

実行時にJavadocコメントを読み取る方法を知る必要があります（おそらくリフレクションによって？）

次の機能があるとします。

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

    //...
}

実行時に、リフレクションによってこの関数に関する多くの情報を得ることができます。しかし、コメントを読むことはできません。したがって、問題は、実行時にこれをどのように読み取るかjavadocコメントです。

javareflectionruntimejavadoc
30
Muhammad Hewedy

Javadocの代わりに注釈を使用し、注釈プロセッサを作成することを検討してください。

15
Puce

ドックレット クラス：

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

そして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>

クラスパスからドキュメントを読む：META-INF/apidocs

31
Khayredinov Dmitriy

できません。それらはコンパイルされたコードから削除されます。

19
Thomas

Javadocが最終クラスにコンパイルされないため、これを行うことはできません。

7
4ndrew