Doxygen vs Javadoc [closed] 質問する

Doxygen vs Javadoc [closed] 質問する

CACM の記事から、Doxygen は Java (および他のいくつかの言語) でも動作することを知りました。しかし、Java にはすでに Javadoc ツールがあります。どちらのアプローチの長所と短所を説明できる人はいますか? それらは相互に排他的ですか? Doxygen 用の Maven プラグインはありますか?

ベストアンサー1

Doxygen には、JavaDoc にはない機能が多数あります。たとえば、階層と連携コンテキストのクラス ダイアグラム、より多くの概要ページ、オプションのソース コード ブラウジング (ドキュメントと相互リンク)、別のページでの @todo などの追加タグ サポート、TeX および PDF 形式での出力の生成などです。また、視覚的なカスタマイズも多数可能です。

Doxygen は標準の JavaDoc タグをサポートしているため、JavaDoc コメント付きの任意のソース コードで Doxygen を実行できます。図やソース コードの参照により、ドキュメントがなくてもコードを理解するのに役立つため、JavaDoc なしでソース コードを実行することも意味があります。また、JavaDoc ツールは不明なタグを無視するため、JavaDoc 生成を中断することなく追加の Doxygen タグを使用することもできます。

とはいえ、私は長い間 Doxygen を使用していないことを認めなければなりません。最近は、同じ視覚化を提供するために IDE に大きく依存する傾向があり、通常は JavaDoc を HTML ページとして読み込まず、ソース ファイルを IDE にインポートして、JavaDoc フライアウトを生成し、定義にジャンプできるようにします。これは、Doxygen が提供する機能よりもさらに強力です。IDE の外部にドキュメントを用意し、Java 以外のツールを実行しても問題ない場合は、Java コードを変更する必要がないため、Doxygen を試してみる価値があります。

おすすめ記事