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

目前有两种方法来将代码标记为在Java中被贬低。

通过JavaDoc

/**
 * @deprecated
 */

或作为注释:

@Deprecated

这是我的问题 – 当使用Eclipse将一个方法标记为过时时,我发现有点太多了。我真的只想使用其中之一。

但是使用注释给编译器实际有用的附加信息吗?

但是只使用注释,我不能说明为什么该方法被弃用 – 我只能使用JavaDoc,并且不推荐一个方法,而不考虑为什么是坏。

所以,我可以只使用其中之一吗?或者我应该真的只是学习指定两个?

你应该使用两者。注释允许编译器在使用过时的方法时显示警告,而javadoc解释了为什么。两者都很重要。

根据Oracle的Java注释tutorial

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

http://stackoverflow.com/questions/5039723/should-i-use-javadoc-deprecation-or-the-annotation-in-java

本站文章除注明转载外,均为本站原创或编译
转载请明显位置注明出处:我应该在Java中使用JavaDoc弃用还是注释?