我应该使用JavaDoc弃用还是在Java中使用注释?

2022-08-31 12:00:50

目前,有两种方法可以在java中将代码标记为贬值。

Via JavaDoc

/**
 * @deprecated
 */

或作为注释:

@Deprecated

这是我的问题 - 我发现在使用Eclipse时将方法标记为已弃用时,同时声明两者有点太多了。我真的只想使用其中之一。

但是,使用注释是否会为编译器提供实际有用的附加信息?

但是仅使用注释,我无法说明为什么该方法被弃用 - 我只能使用JavaDoc执行此操作,并且不指定为什么是坏的弃用方法。

那么,我只能使用其中一个吗?还是我真的应该学会同时指定两者?


答案 1

您应该同时使用两者。注释允许编译器在使用已弃用的方法时显示警告,javadoc 解释了原因。两者都很重要。

根据Oracle的Java Annotations教程

当一个元素被弃用时,也应该使用Javadoc@deprecated标签来记录它...


答案 2

马的嘴里说:

注意:Java 语言规范要求编译器在使用标有@Deprecated注释的类、方法或字段时发出警告。Java 语言规范不要求编译器在访问标有 @deprecated Javadoc 标记的类、方法或字段时发出警告,尽管 Sun 编译器目前这样做。

所以基本上,如果你想要保证会有编译器警告,你需要使用注释。由于一些API设计人员令人叹为观止的无能,您还需要指定javadoc标签来给出解释。

就个人而言,我认为注释是无用的,应该省略,直到它被修复,因为任何好的编译器或IDE也会显示带有javadoc标签的警告。


推荐