java - 我应该使用 JavaDoc 弃用还是 Java 中的注释?

标签 java annotations javadoc deprecated

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

通过 JavaDoc

/**
 * @deprecated
 */

或者作为注解:

@Deprecated

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

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

但仅使用注释,我无法说明为什么不推荐使用该方法 - 我只能使用 JavaDoc 来做到这一点,并且不推荐使用方法而不指定为什么不好。

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

最佳答案

你应该同时使用。 Annotation 允许编译器在使用不推荐的方法时显示警告,javadoc 解释了原因。两者都很重要。

根据 Oracle 的 Java 注释 tutorial :

When an element is deprecated, it should also be documented using the Javadoc @deprecated tag...

关于java - 我应该使用 JavaDoc 弃用还是 Java 中的注释?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5039723/

相关文章:

java - smartGWT 将记录添加到 listGrid 中

java - 使用 JPA 时实现 MVC

java - 具有多个字段的 Spring 自定义注释验证

java - 具有空的 Autowiring 依赖项的 Spring Boot JavaConfig

java - 在 Android Studio 中自定义 Javadoc 模板

java - 如何从命令行生成 Javadoc

java - Liskov 的替换原理与 JAVA 中的覆盖有何关系?完全阻碍和覆盖有什么区别?

java - 需要有关如何将具有相同键的两个值从 json 格式解析为 java map 的建议

java - Spring MVC Controller 配置 - 混合注释和 XML @PathVariable

autocomplete - Intellij IDEA自动显示javadoc