Markdown 形式の Javadoc 生成

前回の記事 のように Apache POI を用いて、直接 Word 形式の Javadoc を生成することが出来ますが Markdown ファイルを作る Doclet を作りました。

1st release.

  • HTML タグの解析は簡易的におこなっているので対応していない HTML タグはタグのまま出力します。
  • Javadoc の対応していないインラインタグは無効化されて出力します。

Ant から実行する場合は以下のような Ant スクリプトになります。ソースコードは GitHub で公開しています。

上記のように実行すると document.md という Markdown ファイルが出来ます。Ant スクリプトを使用せずに直接 Javadoc コマンドを実行する場合は以下のように実行します。

出力された Markdown ファイルを Pandoc で Word 文書に変換する場合は以下のように実行します。

上記の例ではスタイルのテンプレートに reference.docx というファイルを使うようになっています。Ant スクリプトを使用せずに直接 Javadoc コマンドを実行する場合は以下のように実行します。

目次を作成しない場合は --toc --toc-depth=2 のオプションは必要ありません。

テンプレートの reference.docx は自由に作成出来ますが、以下からサンプルをダウンロードしてカスタマイズすることで簡単に用意出来ます。

reference.docx

上記の方法で MarkdownDoclet のソースコード を MarkdownDoclet で変換したサンプルはこちらの Markdown です。これを Pandoc で変換したサンプルはこちらの Word です。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です