@deprecatedタグ

「@deprecated」タグはクラスやメソッドなどを「非推奨」として表示する場合に使います。(非推奨とは、使用はできますが使用すべきではないことを示すものです)。

@deprecated deprecated-text

非推奨を明示する

記述場所 ： 概要、パッケージ、クラス、インターフェース、フィールド、メソッド
複数記述 ： 不可
出力形式 ： 推奨されていません
その他   ：

非推奨になった理由などを文字列として指定します。使い方としては次のようになります。

/**
 *  コメントの説明文
 *  @deprecated 別のメソッドに置き換えられました
 */

また、代替するメソッドやクラスなどへのリンクを合わせて指定します。リンクには{@link}タグを使います({@link} タグについては別のページで詳しく見ていきます)。

/**
 *  コメントの説明文
 *  @deprecated 別のメソッドに置き換えられました {@link #setScale()}
 */

@deprecatedで指定した文字列は「推奨されていません」と言う文字列と合わせてコメントの説明文の前に表示されます。

サンプル

では簡単な例で試してみます。

Sample05.java

/**
 * Javadocテスト用クラス
 */
public class Sample05{
  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   * @deprecated 別のメソッドに置き換えられました {@link #setScale(int, int)}
   */
  public void setSize(int width, int height){

  }

  /**
   * サイズの設定
   * @param width 幅
   * @param height 高さ
   */
  public void setScale(int width, int height){

  }
}

では上記のソースコードを「Sample05.java」の名前で保存し、その保存したディレクトリで次のように実行して下さい。

javadoc -d doc Sample05.java

「doc」ディレクトリ内にある「Sample05.html」ファイルをブラウザで見てください。

「@deprecated」タグで指定した内容は、コメントの説明文よりも前に表示される点に注意して下さい。

※現在では非推奨メソッドやクラスなどの前に「@Deprecated 注釈」を付けることが推奨されています。