如何在Java中注释类的弃用?

2022-09-03 07:16:10

我将弃用Java中的一个类。

@Deprecated
class deprecatedClass

我有这个不推荐使用的类的列表,

List<deprecatedClass> listOfDeperecatedClass

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


编辑:应有大写字母“D”。
请参见: http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html@Deprecated


答案 1

不,您不需要这样做。将注释添加到 将在每次使用时生成警告。@DeprecatedDeprecatedClass


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

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

当然,上述假设您正在向受众编码。如果您是唯一一个使用代码的人,并且您只想弃用以在不破坏生成的情况下清理代码,则只需弃用该类,修复警告并将其删除即可。


答案 2

您是否在 公共界面的一部分上对 执行操作?在这种情况下,也标记所有这些方法。否则你应该没事。Listdeprecated


推荐