[解決済み] Doxygen vs Javadoc [クローズド]。
質問
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は試してみる価値があります。
関連
-
[解決済み] トークンのシンタックスエラー、これらのトークンを削除してください [closed].
-
[解決済み] JVMフラグCMSClassUnloadingEnabledは、実際に何をするのですか?
-
[解決済み] enumのordinalを使用するのは良い習慣ですか?
-
[解決済み] コレクションへの共有参照が見つかりました org.hibernate.HibernateException
-
[解決済み] アクティビティに割り当てられない
-
[解決済み] タイプの安全性。アンチェック・キャスト
-
[解決済み] javadocでメソッドを参照するには?
-
[解決済み] Javadocで外部URLへのリンク?
-
[解決済み] Javadocのコメントで複数行のコード例
-
[解決済み] Mavenを使用する際にJava 8のJavadocの厳しさを回避する方法
最新
-
nginxです。[emerg] 0.0.0.0:80 への bind() に失敗しました (98: アドレスは既に使用中です)
-
htmlページでギリシャ文字を使うには
-
ピュアhtml+cssでの要素読み込み効果
-
純粋なhtml + cssで五輪を実現するサンプルコード
-
ナビゲーションバー・ドロップダウンメニューのHTML+CSSサンプルコード
-
タイピング効果を実現するピュアhtml+css
-
htmlの選択ボックスのプレースホルダー作成に関する質問
-
html css3 伸縮しない 画像表示効果
-
トップナビゲーションバーメニュー作成用HTML+CSS
-
html+css 実装 サイバーパンク風ボタン
おすすめ
-
[解決済み] この配列の中の数字を入れ替えるには、何が足りないのでしょうか?ジャバ
-
[解決済み] android.support.v4.app.FragmentActivity' で 'TAG' がプライベートアクセスされている。
-
[解決済み] javascriptでExpression言語を使うには?
-
[解決済み] mavenのコンパイルに失敗するのはなぜですか?
-
[解決済み] 最も近い整数への切り捨て - 私は不正をしているのでしょうか、それともこれは十分すぎるほど適切なのでしょうか?
-
[解決済み] Apache Camelのログに簡単なテキストを記録する
-
[解決済み] Mavenです。JARは空になります - 含有するためにマークされたコンテンツがありません
-
[解決済み] 文字列が一意な文字であるかどうかを判定する
-
[解決済み] init-paramとcontext-param
-
[解決済み] x--やx++はここで何をするのですか?