1. ホーム
  2. java

[解決済み] Doxygen vs Javadoc [クローズド]。

2022-03-06 13:58:09

質問

CACMの記事で、DoxygenはJava(と他のいくつかの言語)でも動作することに気づきました。しかし、JavaにはすでにJavadocというツールがあります。どなたか、どちらのアプローチの長所と短所を説明していただけませんか?それらは相互に排他的ですか?DoxygenのためのMavenプラグインはありますか?

どのように解決するのですか?

Doxygenには、JavaDocにはない多くの機能があります。例えば、階層や連携コンテキストのクラス図、より多くのサマリーページ、オプションのソースコード閲覧(ドキュメントとクロスリンク)、別ページの@todoなどの追加タグサポート、TeXやPDFフォーマットでの出力が可能で、多くのビジュアル・カスタマイズも可能です。

Doxygenは標準的なJavaDocタグをサポートしているので、JavaDocコメントがあるソースコードであれば、Doxygenを実行することができます。図やソースコードのブラウジングは、ドキュメントがなくてもコードを理解するのに役立つので、JavaDocのないソースコードで実行しても意味がある場合があります。また、JavaDocツールは未知のタグを無視するので、JavaDocの生成を中断することなく、追加のDoxygenタグを使用することができます。

とはいえ、私は長い間Doxygenを使ったことがありません。私は通常、JavaDocをHTMLページとして読むのではなく、ソースファイルをIDEにインポートして、JavaDocのフライアウトを生成し、定義にジャンプできるようにしています。これはDoxygenが提供するものよりもさらに強力なものです。もしあなたがIDEの外にドキュメントを持ちたいなら、そしてJava以外のツールを実行することに満足しているなら、Doxygenは試してみる価値があります。