我班上有一个弃用的方法:
@Deprecated
public void deprecatedMethod() {
//do bad things
}
我不希望该方法出现在javadoc中。 我知道有一个名为-nodeprecated的选项:
“防止产生任何东西 完全弃用了API 文档“。
所以我正在使用此选项,它不会从javadoc中排除该方法。它是javadoc中的错误还是我使用它错了?我还可以做些什么?
(我使用eclipse 3.4.2生成javadoc)
答案 0 :(得分:5)
您必须在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) ...
答案 1 :(得分:0)
@helios
john说你必须在javadoc注释块(/ ** ... * /)中包含@deprecated javadoc标签,就像他上面所做的那样:
@deprecated This method is not sync safe, use setAOk instead
添加此项,然后在运行javadoc时使用-nodeprecated选项,并且这些方法不会出现在生成的文档中。