web-dev-qa-db-ja.com

Javaで廃止されたクラスにコメントする最良の方法は何ですか?

Javaで廃止されたクラスを識別するコメントを追加する最良の方法を知りたいです。他のプログラマーがそのクラスの目的を知るのに役立つ、クラスの上部に追加された前のコメントを削除する必要がありますか、それともコメントの下に追加する必要がありますか?

11
alculete

Javaでクラス、メソッド、またはフィールドを廃止するための推奨されるアプローチは、@Deprecatedアノテーション。Java 5または@deprecated JavaDocタグは、Java 1.1。Oracleから提供されています。Oracleは APIを非推奨にする方法と時期 の詳細について、関連性があると思われるドキュメントを公開しています。

クラスの上部に追加された以前のコメントを削除して、別のプログラマーがそのクラスの目的を理解したり、コメントの下に追加したりできますか?

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

17
Thomas Owens