C++でプログラミングする場合、私はDoxygenを使用して、特定のクラスやメソッド(例えば、複数のクラスからアクセスされるファイルのためのファイルフォーマットドキュメント)には適していない追加のドキュメンテーション用の外部.doxファイルを頻繁に作成します。私はJavaで同じことをする方法を見つけようとしましたが、javadocには同等の機能はなく、すべてのドキュメンテーションは.javaファイルのコメントの中に書かれていなければなりません。パッケージ)。私は正しい?これを行う別の方法がありますか?Javaコードのドキュメントに外部ページを追加するにはどうすればよいですか?
答えて
Javadocが外部ドキュメントを作成できるかどうかを確認する場合は、答えは「いいえ」です。しかし、既に作成した外部ドキュメントにリンクすることができます。さらに、何かがパッケージレベルに適用される場合、ドキュメントを特定のクラスまたはメソッドにアタッチするのではなく、パッケージファイルに置くことができます。
javadoc documentationのセクション「Miscellaneous Unprocessed Files」は、あなたが探しているものです。
ありがとう、私はMUFについて知っていましたが、少し違ったものを探していました。私が忘れているのは、Doxygenの.doxファイルを作成するときに、.doxの中に/からリンクするのと同じ構文(@see、@versionなどを入れることができます)と静的HTMLを使用できるということです可能ではありません。 –
訂正 - もちろんHTMLリンクを置くことはできますが、リンクされたアイテムを移動すると更新されません。 –
- 1. JSFページに外部キーを追加するにはどうすればよいですか?
- 2. 外部JavaライブラリをカスタムAndroidフレームワークに追加するにはどうすればよいですか?
- 3. 反応追加リンクNavbarへの外部リンクを追加するにはどうすればよいですか?
- 4. アプリケーションをページに追加するにはどうすればよいですか?
- 5. ページにカスタムタブを追加するにはどうすればよいですか?
- 6. Shopifyでは、製品以外のページにマウスオーバーを追加するにはどうすればよいですか?
- 7. ソーシャルメディアアイコンをコードに追加するにはどうすればよいですか?
- 8. Eclipseのjava.library.pathに外部ライブラリを追加するにはどうすればよいですか? JOGLで遊ん
- 9. コード内の線形レイアウトの上部にビューを追加するにはどうすればよいですか?
- 10. ページ上部のリンクにトランジションエフェクトを追加するにはどうすればよいですか? HTMLとCSS
- 11. EFコアのIDユーザーに外部キーを追加するにはどうすればよいですか?
- 12. アンドロイドの外部ライブラリに権限を追加するにはどうすればよいですか?
- 13. 既存のSQLiteテーブルに外部キーを追加するにはどうすればよいですか?
- 14. javadocと外部JarsのソースをDomino Designerに追加するにはどうすればよいですか?
- 15. PageDown.jsの外部リンクにrel = "nofollow"属性を追加するにはどうすればよいですか?
- 16. 既存のテーブルに外部キーを追加するにはどうすればよいですか?
- 17. UISplitViewControllerのルートコントローラの下部に追加のツールバーを追加するにはどうすればよいですか?
- 18. Javaに新しい通貨コードを追加するにはどうすればよいですか?
- 19. クラスの外部から属性を追加するにはどうすればよいですか?
- 20. このJavaコードに試行回数を追加するにはどうすればよいですか?
- 21. GoogleスプレッドシートにJavaコードでデータを追加するにはどうすればよいですか?
- 22. 外部Haskellパッケージをスタックプロジェクトに追加するにはどうすればよいですか?
- 23. リーフレットジオコードクエリに外部値を追加するにはどうすればよいですか?
- 24. HDInsight Jupyterに外部依存関係を追加するにはどうすればよいですか?
- 25. 外部スタイルシートをsvgファイルに追加するにはどうすればよいですか?
- 26. Androidに外部ライブラリを追加するにはどうすればよいですか?
- 27. 外部リソースをプロジェクトリソースに追加するにはどうすればよいですか?
- 28. Mujina IDP(IDentity Provider)に外部SP(サービスプロバイダ)を追加するにはどうすればよいですか?
- 29. 外部JSファイルをZurb Foundation 6.4プロジェクト(webpack)に追加するにはどうすればよいですか?
- 30. コードの他の部分に値を動的に追加するにはどうすればいいですか?
パッケージやクラスを作成するだけで、このような情報が含まれているとはどういうことですか(誰かが使用していない空のクラスで、これらのドキュメントを置く場所です)。あまりにも醜いだろうか? –
はい、それは間違いだと思います。ドキュメンテーションのためにあなたのソースコードを汚染しないでください! :) –
コメントファイルを取るスクリプトはどうでしょうか?.jdocと言って、スタブの空のクラスを持つ一時的な.javaファイル内にそれをラップし、javadocコンパイラを実行してから一時ファイルを削除しますか? –