用Java注释不推荐使用的类的最佳方法是什么?


11

我想知道添加注释以标识Java中不推荐使用的类的最佳方法。我应该删除添加到该类顶部的先前注释,以帮助其他程序员了解该类的用途,还是应该将其添加到注释下方?

Answers:


17

建议不要使用Java中的类,方法或字段的方法是使用@Deprecated注释(该注释在Java 5中可用)或@deprecatedJavaDoc标记(自Java 1.1开始就存在)。Oracle有一个文档,说明有关如何以及何时弃用似乎相关的API的细节。

我应该删除添加到类顶部的先前注释,以帮助其他程序员了解该类的用途还是将其添加到注释下方?

除了添加JavaDoc标记或注释之外,您不应编辑或删除任何现有注释。不推荐使用的代码可能仍在旧系统中使用,这些系统的开发人员需要访问原始开发人员以某种形式所做的文档。


1
+1:使用@Depricated批注还可以使诸如Eclipse之类的IDE有所了解,以确保将该方法删除并向开发人员提供其他视觉提示。
瑞安·海斯

是的,我知道如何弃用并且使用掉注释,例如,我有这样的代码/ ** *关于类的注释** /公共类ClassToDeprecate {//这里有一些代码}我应该删除注释并像这样
alculete 2011年

1
@Spammer我链接到的文章对此进行了讨论。另外,浏览Java API文档也可以回答该问题。您唯一要做的就是添加@Deprecated注释或@deprecatedJavaDoc标记。就是这样-仅此而已。
Thomas Owens

顺便说一句,您提供的链接非常有帮助
alculete 2011年

1
添加@deprecatedJavaDoc标签和说明以及@Deprecated注释将使人们更了解为什么不推荐使用它。因此,使用两者而不是仅使用@Deprecated注释会更加有益。
WarFox
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.