javadoc中的-nodeprecated選項似乎不起作用。我能做什么？

Question

我班上有一個棄用的方法：

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

我不希望該方法出現在javadoc中。 我知道有一個名為-nodeprecated的選項：

“完全避免在文檔中生成任何已棄用的API。”

所以我正在使用此選項，它不會從javadoc中排除該方法。 它是javadoc中的錯誤還是我使用它錯了？ 我還可以做些什么？

（我使用eclipse 3.4.2生成javadoc）

Answer 1

您必須在Export to javadoc向導中包含“-nodeprecated”選項。 警告：它是一個javadoc選項，而不是VM選項。

我在Eclipse 3.4中測試了它並且它有效。

編輯：如果您只包含不推薦使用的注釋，則它不起作用。 您還必須在方法javadoc中包含@deprecated標記。

我不知道是否有辦法告訴javadoc使用@Deprecated anotation（奇怪的是沒有一個消息參數來記錄為什么被棄用以及還有什么用）。

編輯： 1.5之前的棄用方法

在“ 不推薦使用 ”之后，您必須在javadoc中包含一個@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) ...

Answer 2

@helios

john說你必須在javadoc注釋塊（/ ** ... * /）中包含@deprecated javadoc標簽，就像他上面所做的那樣：

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

添加它，然后在運行javadoc時使用-nodeprecated選項，並且方法不會出現在生成的doc中。