java - 从 javadocs 制作一个 bitbucket 源 wiki

Question

您好，我正在开发用于我们应用程序的相当大的内部 SDK。我已经配备了大量的 Javadocs。现在我的目标是以某种方式从这些 javadoc 生成 .MD 文件，以便我可以直接将这些 .md 文件放入我的 bitbucket wiki。

有没有办法解决这个问题或生成 bitbucket wiki 可以使用的任何其他文件格式？

Answer 1

Doxygen似乎 support Javadoc-style comments并且可以output 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。