目前,有两种方法可以在 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/