java - javadoc 中的 -nodeprecated 选项似乎不起作用。我能做什么？

Question

我的类中有一个已弃用的方法:

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

我不希望该方法出现在 javadoc 中。我知道有一个选项叫做 -nodeprecated其中:

"Prevents the generation of any deprecated API at all in the documentation."

所以我正在使用这个选项，它不会从 javadoc 中排除该方法。它是 javadoc 中的错误还是我使用错误？我还可以做些什么？

(我正在使用 eclipse 3.4.2 生成 javadoc)

Answer 1

您必须在导出到 javadoc 向导中包含“-nodeprecated”选项。警告:这是一个 javadoc 选项，而不是 VM 选项。

我已经在 Eclipse 3.4 中对其进行了测试并且它有效。

编辑:如果您只包含 Deprecated 注释，则它不起作用。您还必须在方法 javadoc 中包含 @deprecated 标记。

我不知道是否有办法告诉 javadoc 使用 @Deprecated 注释(奇怪的是它没有消息参数来记录为什么不推荐使用以及还可以使用什么)。

编辑:1.5 之前弃用方法的方式

在“已弃用”之后，您必须在要向用户显示的消息中包含一个@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) ...