java - 如何在 Java 中注释类的弃用？

Question

我将弃用 Java 中的一个类。

@Deprecated
class deprecatedClass

我有这个已弃用类的列表，

List<deprecatedClass> listOfDeperecatedClass

那么我是否也需要为此列表添加 @Deprecated 标签？

---

编辑:@Deprecated 应该有一个大写的“D”。
请参阅:http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html

Answer 1

不，你不需要。将注释 @Deprecated 添加到 DeprecatedClass 将在每次使用时生成警告。

---

然而，您应该做的是，将其他类中的方法标记为将已弃用的类作为参数或将其返回为已弃用。这适用于其他代码可能对已弃用类的实例进行的任何访问——公共(public)字段、常量等。如果没有弃用类的实例，那些当然不能使用，因此无论如何都会发出警告，但是在正确的弃用注释和评论中，您应该提供解释并指出替代方案，这是您 需要给予。

方法签名就像契约(Contract)一样，类签名也是如此。您是在告诉其他程序员他们可以调用哪些方法以及如何调用它们。您是在告诉他们哪些字段是可访问的。其他程序员的代码基于此。如果你真的需要打破那个契约，你首先需要提供那个契约的替代品(一个具有相同功能的新方法)，并告诉他们并给他们时间切换到那个新契约(弃用旧的方法和类) .

当然，以上内容假设您正在为观众编写代码。如果您是唯一一个使用您的代码的人，并且您只想弃用以在不破坏构建的情况下清理您的代码，那么只需弃用该类、修复警告并将其删除。