java - 从 javadocs 制作一个 bitbucket 源 wiki

Question

嗨，我正在为我们的应用程序使用相当大的内部 SDK。我配备了广泛的 Javadocs。现在我的目标是以某种方式从这些 javadocs 生成 .MD 文件，以便我可以直接将这些 .md 文件放入我的 bitbucket wiki。

有没有办法做到这一点或生成 bitbucket wiki 可以使用的任何其他文件格式？

Answer 1

Doxygen似乎支持 Javadoc 样式的注释并且可以输出 LaTeX。LaTeX 可以被Pandoc使用，它支持 Markdown 输出。这有点迂回，但这是我能看到的唯一现实的选择。

类似于以下内容（未经测试）

# Generate a Doxygen configuration file, which
# should enable LaTeX output by default
doxygen -g

# Generate LaTeX documentation in the latex/ directory
doxygen

# Generate one Markdown file for each LaTeX file
find latex/ -name '*.tex' -exec mkdir -p markdown/`dirname {}` && \
    pandoc -o markdown/`basename {} .pdf`.md {} \;

应该让你接近。

另一种方法可能是采用 Javadoc 生成的 HTML 并使用 Pandoc 摄取，输出 Markdown。