如何将Java方法声明或标记为已弃用?
我想让我的一个方法“不赞成”=不再使用。
但我仍然想在我的API中使用它。 我只是想向使用该方法的任何人显示“警告”。
我怎样才能做到这一点?
在方法上使用@Deprecated。 不要忘记澄清javadoc领域:
/**
* Does some thing in old style.
*
* @deprecated use {@link #new()} instead.
*/
@Deprecated
public void old() {
// ...
}
使用@Deprecated
注释和@deprecated
JavaDoc标签。
@deprecated
JavaDoc标记用于文档目的。
@Deprecated
注释指示编译器该方法已被弃用。 Sun / Oracles关于这个主题的文件中提到:
使用@Deprecated
注释来弃用类,方法或字段可确保所有编译器在代码使用该程序元素时发出警告。 相反,不能保证所有的编译器总是发出基于@deprecated
Javadoc标签的警告,尽管目前Sun编译器这样做。 其他编译器可能不会发出这样的警告。 因此,使用@Deprecated
注释来生成警告更依赖于@deprecated
Javadoc标签。
您可以在如何以及何时弃用API中找到完整的文档
有两件事你可以做:
@Deprecated
注释添加到方法中 @deprecated
标记添加到方法的javadoc 你应该两个都做 !
引用关于这个主题的java文档:
从J2SE 5.0开始,通过使用@Deprecated注释来弃用类,方法或字段。 另外,你可以使用@deprecated Javadoc标签告诉开发者使用什么。
使用注释会导致Java编译器在使用不推荐使用的类,方法或字段时生成警告。 如果不推荐使用的编译单元使用已弃用的类,方法或字段,则编译器会抑制弃用警告。 这使您可以构建传统API而不会产生警告。
强烈建议您使用带有适当注释的Javadoc @deprecated标签,以解释如何使用新的API。 这可确保开发人员将具有从旧API到新API的可行迁移路径
链接地址: http://www.djcxy.com/p/13283.html