java - @deprecated 与 @Deprecated

Question

这个问题在这里已经有了答案:

How to declare or mark a Java method as deprecated? (6 个回答)

关闭 8年前。

我可以使用 @Deprecated 注释来弃用函数或类。

但是在 javadoc 注释本身中有一个 @deprecated javadoc 标记，将类/函数标记为已弃用。 @deprecated javadoc 标签是否真的使类/函数被弃用了？

Answer 1

@Deprecated是编译器读取的注解，用于将方法标记为编译器已弃用，如果使用该方法，将生成弃用编译时警告。

@deprecated是一个 javadoc 标记，用于提供有关弃用的文档。您可以使用它来解释为什么不推荐使用该方法并建议替代方法。只有将此标记与@Deprecated 注解结合使用才有意义。

示例用法:

/**
 * This method does ...
 * @deprecated As of <product> <version>, because ... use
 *             {@link #replacementMethod()} instead.
 */
@Deprecated
public void deprecatedMethod() {
    // ...
}

这里是 guide on deprecation ，请查看以获取更多信息。

---

要更具体地回答您的问题，您应该使用 @Deprecated 或同时使用两者。 @Deprecated 注释将您的方法标记为已弃用任何关心它的工具，因为它在运行时和编译时都可用。 javadoc 工具会注意到 @Deprecated 并记录弃用，即使您没有使用 @deprecated 标记。

如果我们使用 javadoc 标记将一个方法记录为已弃用，但没有使用注解对其进行注解，则有关弃用的信息将不会在编译的类文件中可用。