如何将 Java 方法声明或标记为已弃用？

java deprecated

2022-08-31 05:02:20

我想让我的一个方法“弃用”=不再使用。

但我仍然希望将其放在我的API中。我只想向使用该方法的任何人显示“警告”。

我怎样才能做到这一点？

答案 1

使用@Deprecated方法。不要忘记澄清javadoc字段：

/**
 * Does some thing in old style.
 *
 * @deprecated use {@link #new()} instead.  
 */
@Deprecated
public void old() {
// ...
}

答案 2

同时使用注解和 JavaDoc 标记。@Deprecated@deprecated

JavaDoc 标记用于文档目的。@deprecated

该批注指示编译器弃用该方法。以下是它在Sun/ Oracles文档中关于这个主题的内容：@Deprecated

使用@Deprecated注释来弃用类、方法或字段可确保所有编译器在代码使用该程序元素时都会发出警告。相比之下，不能保证所有编译器都始终会根据@deprecated Javadoc 标签发出警告，尽管 Sun 编译器目前这样做。其他编译器可能不会发出此类警告。因此，使用@Deprecated注释来生成警告比依赖@deprecated Javadoc 标记更具可移植性。

您可以在如何以及何时弃用 API 中找到完整文档