Javaで非推奨のクラスにコメントする最良の方法は何ですか?


11

Javaで非推奨のクラスを識別するためのコメントを追加する最良の方法を知りたいです。クラスの先頭に追加された以前のコメントを削除して、別のプログラマーがそのクラスの目的を理解できるようにするか、コメントの下に追加する必要がありますか?

回答:


17

Javaでクラス、メソッド、またはフィールドを非推奨にするための推奨されるアプローチは@Deprecated、Java 5で使用可能になった注釈、または@deprecatedJava 1.1以降に使用されているJavaDocタグを使用することです。Oracleには、関連があると思われるAPIを非推奨にする方法と時期に関する詳細についてのドキュメントがあります。

クラスの先頭に追加された以前のコメントを削除して、別のプログラマーがそのクラスの目的を知るのに役立つようにするか、コメントの下に追加する必要がありますか?

JavaDocタグまたは注釈を追加する場合を除き、既存のコメントを編集または削除しないでください。廃止されたコードは依然としてレガシーシステムで使用されている可能性があり、それらのシステムの開発者は、元の開発者が何らかの形で行ったドキュメントにアクセスする必要があります。


1
+1:@Depricatedアノテーションを使用すると、EclipseなどのIDEに注意を向けて、そのメソッドを確実に無効にし、他の視覚的なヒントを開発者に提供できます。
ライアンヘイズ

はい、私は質問を非推奨にする方法とアノテーションを使用する方法を知っています。たとえば、このコードがあります
-alculete

1
@Spammer私がリンクした記事はそれについて議論しています。また、Java APIドキュメントを参照すると、その答えが得られます。行うべきことは、@Deprecated注釈または@deprecatedJavaDocタグを追加することだけです。それだけです-他に何もありません。
トーマスオーエンズ

ちなみに、あなたが与えたリンクは非常に
役に立ち

1
@deprecatedJavaDocタグと説明を@Deprecated注釈とともに追加すると、非推奨になった理由が明らかになります。したがって、単なる@Deprecated注釈ではなく両方を使用する方が有益です。
WarFox
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.