如何在Java中注释不赞成使用的类?

问题描述 投票:13回答:4

我将弃用Java中的类。

@Deprecated
class deprecatedClass

并且我有此不推荐使用的类的列表,

List<deprecatedClass> listOfDeperecatedClass

所以我也需要为此列表添加@Deprecated标签吗?


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

java annotations deprecated
4个回答
5
投票

不,您不需要。将注解@Deprecated添加到DeprecatedClass会在每次使用时生成一条警告。


然而,您[[应该做的是标记other类中的方法,这些方法将不赞成使用的类作为参数,或者也将不赞成使用的返回它。这样就可以使其他代码可以访问已弃用的类的实例(公共字段,常量等)。当然,如果没有弃用的类的实例就不能使用这些选项,因此仍然会给出警告,但是在正确的弃用注释和注释中,您应该提供解释并指向替代方法,这是您需要给予。

方法签名就像合同,类签名也是如此。您正在告诉其他程序员他们可以调用哪些方法以及如何调用它们。您要告诉他们哪些字段可以访问。其他程序员则以此为基础。如果您确实需要违反该合同,则首先需要提供该合同的替代品(具有相同功能的新方法),并告诉他们并给他们时间切换到该新合同(不赞成使用旧方法和类) 。

当然,以上假设您是在向受众编码。如果您是唯一使用代码的人,并且只想弃用清理代码而不破坏构建,则只弃用该类,修复警告,然后将其删除。


4
投票
您是否在List上进行了操作,并将其作为公共界面的一部分?在这种情况下,请将所有这些方法也标记为deprecated。否则,你应该没事。

2
投票
您只需要在您要弃用的任何东西的声明中添加弃用消息。它警告人们应该避免使用不推荐使用的类的实现,例如List<DeprecatedClass>

1
投票
仅标记为:

@Deprecated List<deprecatedClass> listOfDeperecatedClass

应该没事。
© www.soinside.com 2019 - 2024. All rights reserved.