@deprecated
日本語 | 推奨されていません |
英語 | atmark deprecated |
ふりがな | でぷりけーてっど |
フリガナ | デプリケーテッド |
「推奨されていません」と出力するためのタグ。
Javadocのタグのひとつ。ドキュメンテーションコメント内に「@deprecated 説明」と記述することで、Javadocによって出力されたドキュメントに「推奨されていません。 説明」と記述される。
また、このタグはコンパイル時にも影響を与える。
ドキュメンテーションコメント内にこのタグを記述すると、記述されたクラス、メソッド、フィールドはクラスファイルに「Deprecated」の印が付けられる。
他のクラスのメソッドから、「Deprecated」の印が付けられたクラス、メソッド、フィールドを使用すると、「警告」として「使用すべきではありません」と出力される。
Javadocのタグのひとつ。ドキュメンテーションコメント内に「@deprecated 説明」と記述することで、Javadocによって出力されたドキュメントに「推奨されていません。 説明」と記述される。
また、このタグはコンパイル時にも影響を与える。
ドキュメンテーションコメント内にこのタグを記述すると、記述されたクラス、メソッド、フィールドはクラスファイルに「Deprecated」の印が付けられる。
他のクラスのメソッドから、「Deprecated」の印が付けられたクラス、メソッド、フィールドを使用すると、「警告」として「使用すべきではありません」と出力される。
参考サイト
// 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()
{
}
}
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() { } }