JavaA2Z

KAB-studio > プログラミング > JavaA2Z > @deprecatedとは

@deprecated

日本語 推奨されていません
英語 atmark deprecated
ふりがな でぷりけーてっど
フリガナ デプリケーテッド

解説

推奨されていません」と出力するためのタグ
Javadocタグのひとつ。ドキュメンテーションコメント内に「@deprecated 説明」と記述することで、Javadocによって出力されたドキュメントに「推奨されていません。 説明」と記述される。
 
また、このタグコンパイル時にも影響を与える。
ドキュメンテーションコメント内にこのタグを記述すると、記述されたクラスメソッドフィールドクラスファイルに「Deprecated」の印が付けられる。
他のクラスメソッドから、「Deprecated」の印が付けられたクラスメソッドフィールドを使用すると、「警告」として「使用すべきではありません」と出力される。

参考サイト


(KAB-studioからのおしらせです)

サンプルプログラム(とか)サンプルを別ウィンドウで表示サンプルをクリップボードへコピー(WindowsでIEの場合のみ)

// Sample.java
import java.util.Date;

public class Sample
{
    public static void main( String[] args )
    {
        // 「推奨されていません」なメソッドを使用します。
        Date date = new Date( 2004, 0, 1 );
        // コンパイル時の警告:
        // コンストラクター Date(int, int, int) は使用すべきではありません。
        // でも使用することは可能。

        // 自分が作ったクラスやそのメソッドを「推奨されていません」に
        // する場合には、クラスやメソッドのドキュメンテーションコメント内に
        // @deprecatedタグを加えます。
        DeprecatedClass deprecatedClass = new DeprecatedClass();
        // 警告:
        // 型 DeprecatedClass は使用すべきではありません。

        deprecatedClass.deprecatedMethod();
        // 警告:
        // メソッド deprecatedMethod() は型 DeprecatedClass で使用すべきではありません。

        // 注:基本的に、自クラスのメソッドに@deprecatedタグを付けて
        //     使用しても警告は出ません。これは、@deprecatedタグの
        //     「印」がクラスファイルに付けられるためで、コンパイル時には
        //     参照されないからです。
    }
}


// DeprecatedClass.java

/**
*   使用を推奨しないクラス。
*   @deprecated このクラスは使わないでください。
*/
public class DeprecatedClass
{
    /**
    *   使用を推奨しないメソッド。
    *   @deprecated このメソッドは使用しないでください。
    */
    public void deprecatedMethod()
    {
    }
}
// Sample.java
import java.util.Date;

public class Sample
{
    public static void main( String[] args )
    {
        // 「推奨されていません」なメソッドを使用します。
        Date date = new Date( 2004, 0, 1 );
        // コンパイル時の警告:
        // コンストラクター Date(int, int, int) は使用すべきではありません。
        // でも使用することは可能。

        // 自分が作ったクラスやそのメソッドを「推奨されていません」に
        // する場合には、クラスやメソッドのドキュメンテーションコメント内に
        // @deprecatedタグを加えます。
        DeprecatedClass deprecatedClass = new DeprecatedClass();
        // 警告:
        // 型 DeprecatedClass は使用すべきではありません。

        deprecatedClass.deprecatedMethod();
        // 警告:
        // メソッド deprecatedMethod() は型 DeprecatedClass で使用すべきではありません。

        // 注:基本的に、自クラスのメソッドに@deprecatedタグを付けて
        //     使用しても警告は出ません。これは、@deprecatedタグの
        //     「印」がクラスファイルに付けられるためで、コンパイル時には
        //     参照されないからです。
    }
}


// DeprecatedClass.java

/**
*   使用を推奨しないクラス。
*   @deprecated このクラスは使わないでください。
*/
public class DeprecatedClass
{
    /**
    *   使用を推奨しないメソッド。
    *   @deprecated このメソッドは使用しないでください。
    */
    public void deprecatedMethod()
    {
    }
}

この単語を含むページ

「みだし」に含まれているページ

「解説」に含まれているページ

「サンプルプログラムとか」に含まれているページ

はてなブックマーク 詳細を表示 はてなブックマーク ブックマーク数
livedoorクリップ 詳細を表示 livedoorクリップ ブックマーク数
Yahoo!ブックマーク 詳細を表示 users
del.icio.us 登録する RSSに登録
サンプルを別ウィンドウで表示
サンプルをクリップボードへコピー(WindowsでIEの場合のみ)
update:2005/07/23
このページは、Javaプログラミング言語についての用語を網羅した辞書「JavaA2Z」の一ページです。
詳しくは「JavaA2Z」表紙の説明をご覧ください。