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”选项。警告：这是一个 javadoc 选项，而不是 VM 选项。

我已经在 Eclipse 3.4 中对其进行了测试，并且可以正常工作。

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

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

编辑： before-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) ...
于 2010-01-19T12:29:36.273 回答
0

@helios

john 说您必须在 javadoc 注释块 (/** ... */) 中包含 @deprecated javadoc 标记，就像他在上面所做的那样：

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

添加这个，然后在运行 javadoc 时使用 -nodeprecated 选项，这些方法将不会出现在生成的文档中。

于 2010-01-19T13:06:57.803 回答