如何将JavaDoc转换为Markdown？

Question

我有一个完全用 Java 编写的 Android 库，其中包含一堆注释，我可以将它们生成到 JavaDoc 中并以 HTML 格式查看。

我想找到一种方法将我的JavaDoc转换为Markdown，或者直接从我的Android库中的注释生成Markdown项目。

作为参考，我研究了 Dokka，它似乎只适用于 Kotlin 项目，所以这似乎不在等式中。

Answer 1

您可以使用marklet lib将JavaDoc转换为markdown。Marklet Github链接。 如果你使用maven，你可以在你的pom中配置它

  <plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-javadoc-plugin</artifactId>
    <version>2.9</version>
    <configuration>
        <doclet>fr.faylixe.marklet.Marklet</doclet>
        <docletArtifact>
            <groupId>fr.faylixe</groupId>
            <artifactId>marklet</artifactId>
            <version>1.1.0</version>
        </docletArtifact>
        <reportOutputDirectory>./</reportOutputDirectory>
        <destDir>./</destDir>
        <additionalparam>-d javadoc/</additionalparam>
        <useStandardDocletOptions>false</useStandardDocletOptions>
    </configuration>
</plugin>

Answer 2

您可以使用

dokka

将javadoc直接输出到markdown中（至少是Github风格的Markdown）（参考。https://medium.com/androiddevnotes/how-to-use-dokka-documentation-engine-for-android -gradle-生成-kdoc-或-javadoc-comments-2b5f177595ec）

./gradlew clean app:dokkaGfm

和中提琴！