4

クラスに非推奨のメソッドがあります。

@Deprecated
public void deprecatedMethod() {
   //do bad things
}

そのメソッドをjavadocに表示したくありません。私は-nodeprecatedと呼ばれるオプションがあることを知っています：

「ドキュメントで非推奨のAPIが生成されないようにします。」

したがって、私はこのオプションを使用しており、javadocからメソッドを除外していません。これはjavadocのバグですか、それとも間違って使用していますか？他に何ができますか？

（私はEclipse 3.4.2を使用してjavadocを作成しています）

4

2 に答える 2

5

Export to javadoc ウィザードに「-nodeprecated」オプションを含める必要があります。警告: これは VM オプションではなく、javadoc オプションです。

私はEclipse 3.4でテストしましたが、うまくいきました。

編集:非推奨の注釈のみを含めると、機能しません。メソッド javadoc 内にも @deprecated タグを含める必要があります。

javadoc に @Deprecated アノテーションを使用するように指示する方法があるかどうかはわかりません (不思議なことに、非推奨の理由と他に何を使用するかを文書化するメッセージ パラメータがありません)。

編集：非推奨メソッドの1.5前の方法

javadoc の「 deprecated 」の後に、ユーザーに表示するメッセージに @deprecated タグ (またはインジケーターなど) を含める必要があります。

/**
  This method sets the property A.
  @see getA
  @author helios
  @deprecated This method is not sync safe, use setAOk instead
 */
public void setA(String value) ...
于 2010-01-19T12:29:36.273 に答える
0

@ヘリオス

john は、上記で行ったように、javadoc コメント ブロック (/** ... */) 内に @deprecated javadoc タグを含める必要があると言っています。

@deprecated This method is not sync safe, use setAOk instead

これを追加し、javadoc の実行時に -nodeprecated オプションを使用すると、生成されたドキュメントにメソッドが表示されなくなります。

于 2010-01-19T13:06:57.803 に答える