2009-03-09 17 views
4

C++でプログラミングする場合、私はDoxygenを使用して、特定のクラスやメソッド(例えば、複数のクラスからアクセスされるファイルのためのファイルフォーマットドキュメント)には適していない追加のドキュメンテーション用の外部.doxファイルを頻繁に作成します。私はJavaで同じことをする方法を見つけようとしましたが、javadocには同等の機能はなく、すべてのドキュメンテーションは.javaファイルのコメントの中に書かれていなければなりません。パッケージ)。私は正しい?これを行う別の方法がありますか?Javaコードのドキュメントに外部ページを追加するにはどうすればよいですか?

答えて

2

Javadocが外部ドキュメントを作成できるかどうかを確認する場合は、答えは「いいえ」です。しかし、既に作成した外部ドキュメントにリンクすることができます。さらに、何かがパッケージレベルに適用される場合、ドキュメントを特定のクラスまたはメソッドにアタッチするのではなく、パッケージファイルに置くことができます。

+0

パッケージやクラスを作成するだけで、このような情報が含まれているとはどういうことですか(誰かが使用していない空のクラスで、これらのドキュメントを置く場所です)。あまりにも醜いだろうか? –

+0

はい、それは間違いだと思います。ドキュメンテーションのためにあなたのソースコードを汚染しないでください! :) –

+0

コメントファイルを取るスクリプトはどうでしょうか?.jdocと言って、スタブの空のクラスを持つ一時的な.javaファイル内にそれをラップし、javadocコンパイラを実行してから一時ファイルを削除しますか? –

4

javadoc documentationのセクション「Miscellaneous Unprocessed Files」は、あなたが探しているものです。

+0

ありがとう、私はMUFについて知っていましたが、少し違ったものを探していました。私が忘れているのは、Doxygenの.doxファイルを作成するときに、.doxの中に/からリンクするのと同じ構文(@see、@versionなどを入れることができます)と静的HTMLを使用できるということです可能ではありません。 –

+0

訂正 - もちろんHTMLリンクを置くことはできますが、リンクされたアイテムを移動すると更新されません。 –

関連する問題