私のメソッドの1つを「非推奨」にしたい=もう使用しません。
しかし、それでも私はそれを私のAPIに入れたいです。私はその方法を使用しているすべての人に「警告」を表示したいだけです。
どうすればそれを達成できますか?
私のメソッドの1つを「非推奨」にしたい=もう使用しません。
しかし、それでも私はそれを私のAPIに入れたいです。私はその方法を使用しているすべての人に「警告」を表示したいだけです。
どうすればそれを達成できますか?
回答:
@Deprecated
メソッドで使用します。javadocフィールドを明確にすることを忘れないでください。
/**
* Does some thing in old style.
*
* @deprecated use {@link #new()} instead.
*/
@Deprecated
public void old() {
// ...
}
reason
、デフォルト値の別の属性を追加し""
ても害はありませんでした
@deprecated
コメント内のメッセージを追加できるようにしたいのですが@Deprecated
(すべてを修正するための1つのスポット)...
両方を使用し@Deprecated
、注釈と@deprecated
JavaDocタグのます。
の @deprecated
JavaDocのタグは、文書化のために使用されます。
@Deprecated
注釈は、この方法は推奨されていることをコンパイラに指示します。これは、この件に関するSun / Oraclesのドキュメントでの説明です。
使用する
@Deprecated
コードは、そのプログラム要素を使用する場合、すべてのコンパイラが警告を発行することを、クラス、メソッド、またはフィールドの性を保証を廃止するために注釈を。対照的に、@deprecated
Sunコンパイラは現在、すべてのコンパイラがJavadocタグに基づいて常に警告を発行するという保証はありません。他のコンパイラはそのような警告を発しないかもしれません。したがって、@Deprecated
アノテーションを使用して警告を生成する方が、@deprecated
Javadocタグに依存するよりも移植性が高くなります。
完全なドキュメントは、APIを非推奨にする方法と時期にあります。
@deprecated
javadocタグ(Java 4の場合)でマークすると、コンパイラーはメソッド(クラス、フィールド)を非推奨としてマークし、ソースが利用できない場合でもIDEは警告を表示しました。
いくつかの小さな説明が欠けていたので
@Deprecated
このようなメソッドでアノテーションを使用する
/**
* @param basePrice
*
* @deprecated reason this method is deprecated <br/>
* {will be removed in next version} <br/>
* use {@link #setPurchasePrice()} instead like this:
*
*
* <blockquote><pre>
* getProduct().setPurchasePrice(200)
* </pre></blockquote>
*
*/
@Deprecated
public void setBaseprice(int basePrice) {
}
<br/>
{@link #setPurchasePrice()}
できることは2つあります。
@Deprecated
メソッドにアノテーションを@deprecated
メソッドのjavadocにタグを追加しますあなたは両方をするべきです!
このテーマに関するJavaドキュメントを引用:
J2SE 5.0以降では、@ Deprecatedアノテーションを使用してクラス、メソッド、またはフィールドを非推奨にします。さらに、@ deprecated Javadocタグを使用して、代わりに何を使用するかを開発者に伝えることができます。
アノテーションを使用すると、非推奨のクラス、メソッド、またはフィールドが使用されたときに、Javaコンパイラーが警告を生成します。非推奨のコンパイル単位が非推奨のクラス、メソッド、またはフィールドを使用する場合、コンパイラーは非推奨警告を抑制します。これにより、警告を生成せずにレガシーAPIを構築できます。
新しいAPIの使用方法を説明する適切なコメント付きのJavadoc @deprecatedタグを使用することを強くお勧めします。これにより、開発者は古いAPIから新しいAPIへの移行可能なパスを確保できます