C++でプログラミングする場合、私はDoxygenを使用して、特定のクラスやメソッド(例えば、複数のクラスからアクセスされるファイルのためのファイルフォーマットドキュメント)には適していない追加のドキュメンテーション用の外部.doxファイルを頻繁に作成します。私はJavaで同じことをする方法を見つけようとしましたが、javadocには同等の機能はなく、すべてのドキュメンテーションは.javaファイルのコメントの中に書かれていなければなりません。パッケージ)。私は正しい?これを行う別の方法がありますか?Javaコードのドキュメントに外部ページを追加するにはどうすればよいですか?
答えて
Javadocが外部ドキュメントを作成できるかどうかを確認する場合は、答えは「いいえ」です。しかし、既に作成した外部ドキュメントにリンクすることができます。さらに、何かがパッケージレベルに適用される場合、ドキュメントを特定のクラスまたはメソッドにアタッチするのではなく、パッケージファイルに置くことができます。
javadoc documentationのセクション「Miscellaneous Unprocessed Files」は、あなたが探しているものです。
ありがとう、私はMUFについて知っていましたが、少し違ったものを探していました。私が忘れているのは、Doxygenの.doxファイルを作成するときに、.doxの中に/からリンクするのと同じ構文(@see、@versionなどを入れることができます)と静的HTMLを使用できるということです可能ではありません。 –
訂正 - もちろんHTMLリンクを置くことはできますが、リンクされたアイテムを移動すると更新されません。 –
- 1. 外部JavaライブラリをカスタムAndroidフレームワークに追加するにはどうすればよいですか?
- 2. アプリケーションをページに追加するにはどうすればよいですか?
- 3. ページにカスタムタブを追加するにはどうすればよいですか?
- 4. Shopifyでは、製品以外のページにマウスオーバーを追加するにはどうすればよいですか?
- 5. Eclipseのjava.library.pathに外部ライブラリを追加するにはどうすればよいですか? JOGLで遊ん
- 6. コード内の線形レイアウトの上部にビューを追加するにはどうすればよいですか?
- 7. 既存のSQLiteテーブルに外部キーを追加するにはどうすればよいですか?
- 8. 既存のテーブルに外部キーを追加するにはどうすればよいですか?
- 9. UISplitViewControllerのルートコントローラの下部に追加のツールバーを追加するにはどうすればよいですか?
- 10. Javaに新しい通貨コードを追加するにはどうすればよいですか?
- 11. 外部スタイルシートをsvgファイルに追加するにはどうすればよいですか?
- 12. 外部リソースをプロジェクトリソースに追加するにはどうすればよいですか?
- 13. コードの他の部分に値を動的に追加するにはどうすればいいですか?
- 14. 外部アプリなしでURLからドキュメントを表示するにはどうすればよいですか?
- 15. GoでAPIドキュメントに例を追加するにはどうすればよいですか?
- 16. カスタム属性にドキュメントを追加するにはどうすればよいですか?
- 17. JavaScriptドキュメントをNetBeansに追加するにはどうすればよいですか?
- 18. Android:このContentProviderコードを外部クラスに移動するにはどうすればよいですか?
- 19. カスタマーアカウントのダッシュボードに新しいページを追加するにはどうすればよいですか?
- 20. Magentoのすべてのページにcmsスタティックブロックを追加するにはどうすればよいですか?
- 21. Javaでは、JButtonのツールチップに改行を追加するにはどうすればよいですか?
- 22. JavaからSQLiteに外部キー制約を適用するにはどうすればよいですか?
- 23. Gladeでは、アシスタントにページを追加するにはどうすればよいですか?
- 24. 外部JavaScriptファイルをインポートするにはどうすればよいですか?
- 25. どのように.net XMLドキュメントに余分なページを追加しますか?
- 26. データストアにデータを追加するコードを最適化するにはどうすればよいですか?
- 27. 別のページに異なるヘッダーを追加するにはどうすればよいですか?
- 28. SQLTABLEの結果を外部ページにリンクさせるにはどうすればよいですか?
- 29. テーブルに値を追加するにはどうすればよいですか?
- 30. アラートパネルにチェックボックスを追加するにはどうすればよいですか?
パッケージやクラスを作成するだけで、このような情報が含まれているとはどういうことですか(誰かが使用していない空のクラスで、これらのドキュメントを置く場所です)。あまりにも醜いだろうか? –
はい、それは間違いだと思います。ドキュメンテーションのためにあなたのソースコードを汚染しないでください! :) –
コメントファイルを取るスクリプトはどうでしょうか?.jdocと言って、スタブの空のクラスを持つ一時的な.javaファイル内にそれをラップし、javadocコンパイラを実行してから一時ファイルを削除しますか? –