問題タブ [javadoc]

クラスの一部として@versionとの両方を含める理由はありますか?@since

それらは相互に排他的であるようです。

また、とは何%I%を%G% 意味し、どのように設定/使用するのですか?

わかりました、友情がカプセル化を破るかどうかの議論を残して、実際にエレガントに首尾一貫したデザインを考え出してみましょう. これは 2 つの機能です。

1) 実装方法に関する一般的な質問:

2) なぜこの機能が必要なのですか? 私のクラスのいくつかは、Serializable インターフェイスを実装しています。ただし、Serializable メソッドを Derived クラスで保護して、それらをクライアント (およびドキュメント -- javadoc) に公開しないようにしたいと考えています。ただし、内部クラスはそれらにアクセスできる必要があります。Javaでこの問題を解決する一般的な方法は何ですか?

注: 現在の C++ 標準で定義されているフレンドシップを使用しています。

ありがとう

コンパイル時に何千もの警告が表示されるレガシーJavaコードベースで立ち往生しています。これらすべての警告の原因を実際に修正したいと思いますが、残念ながら、現時点ではそれは私の会社の選択肢ではありません（「収益を生み出す新製品を作る」などの他のことは、担当者によって優先度が高いと考えられています。 。

これで、継続的ビルドサーバーからの出力で実際のエラーを見つけるのが困難になるという事実がなければ、これらすべての警告に耐えることができました。ビルドサーバーはant呼び出しを使用するだけで、特別なことは何もありませんが、これまでのところ、警告出力を防ぐためにこの呼び出しを変更する方法については何も見つかりませんでした。

コードを調べて@SuppressWarningsアノテーションをどこにでも追加することは機能しますが、すべての警告のソースを調べて修正するのとほぼ同じくらいの苦痛も伴います。だから私が本当に好きなのは、私にできる方法があったかどうかです。

または同様のもので、javadocコンパイラがすべての警告メッセージを出力しないようにします。このようなもの（グローバルjavadoc警告の無効化）は可能ですか？

Java API では、パッケージの Javadoc コメントを確認できます。

パッケージを文書化する Javadoc コメントはどのように/どこに配置すればよいですか?

クラスから廃止されたメソッドのリストを取得するにはどうすればよいですか。

クラスがドキュメントに渡すために非推奨としてマークされたメソッドをリストする必要があります。

各メソッドとその javadoc を個別のファイルにコピー アンド ペーストしたくありません。javadoc ツールまたは eclipse を使用してこれを行うことは可能ですか?

*/JavaDoc コメントに含める必要があります。問題は、これがコメントを閉じるための同じシーケンスでもあることです。これを引用/エスケープする適切な方法は何ですか?

例：

追記/：スラッシュに使えそうです。唯一の欠点は、テキスト エディターでコードを直接表示した場合、これだけでは十分に読めないことです。

「${person}」の部分は中かっこを使用しているため、ドキュメントのコメントが壊れています。

javadocAntタスクを介して実行したときにJavadocが出力する警告をキャプチャすることは可能ですか？タスクにあるような出力属性が表示されません。Checkstyleがキャッチされていないという警告があるようです。その出力をファイルに取り込むと、問題が発生する可能性があります。

奇妙に思えますが、これは捕らえられないでしょう。うまくいけば、私は明らかな何かを見逃しています。

〜*〜*〜*〜編集（以下の回答）〜*〜*〜*〜

Ant<record>タスクがまさに私が探していたものであるように見えます。Antのドキュメントを参照してください。