如何在Java中注释对类的弃用?
我将弃用Java中的一个类。
@Deprecated class deprecatedClass
我有这个已弃用的类的列表,
List listOfDeperecatedClass
那么我是否也需要为此列表添加@Deprecated
标签?
编辑: @Deprecated
应该有一个大写’D’。
请参阅: http : //docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html
不,你不需要。 将注释@Deprecated
添加到DeprecatedClass
将在每次DeprecatedClass
时生成警告。
但是,您应该做的是在其他类中标记方法, 这些方法将您已弃用的类作为参数或返回它,也称为已弃用。 这适用于其他代码可能对您不推荐使用的类的实例的访问 – 公共字段,常量等。 那些当然不能在没有你弃用的calss的实例的情况下使用,所以无论如何都会给出警告,但是在正确的弃用注释和注释中,你应该提供一个解释并指出一个替代方案,这是你需要的有价值的信息。给。
方法签名就像一个契约,因此是一个类签名。 你告诉其他程序员他们可以调用什么方法以及如何调用它们。 你告诉他们哪些字段是可访问的。 其他程序员的代码基于此。 如果你真的需要打破这个合同,你首先需要提供一个替代合同(一个具有相同function的新方法),并告诉他们并给他们时间切换到新合同(弃用旧方法和类) 。
当然,以上假设您正在为观众编码。 如果您是唯一一个使用您的代码并且您只想弃用以清除代码而不破坏构建的人,则只需弃用该类,修复警告并将其删除即可。
作为公共界面的一部分,您是否在List
上进行操作? 在这种情况下,请将所有这些方法标记为deprecated
。 否则你应该没事。
您只需要将弃用消息添加到您要弃用的任何声明中。 它用作警告,人们应该避免使用已弃用类的实现,例如在List
。
标记为:
@Deprecated List listOfDeperecatedClass
应该没问题。