@see和@inheritDoc之间的区别细节

我已经看了JavaDoc的参考 ，虽然我了解@see （各种链接）和{@inheritDoc} （超类JavaDoc注释的导出）之间的基本区别，我需要澄清事情如何实际执行。

在Eclipse IDE中，当我为inheritance的方法（从接口，或toString（）覆盖等等）select“生成元素注释”时，会创build以下注释

 /* (non-Javadoc) * @see SomeClass#someMethod() */ 

如果我需要生成JavaDoc，我应该把它{@inheritDoc} ，用{@inheritDoc}replace@see ，或者把它转换成真正的 JavaDoc：

 /** * {@inheritDoc} */ 

当我这样做的时候，我还应该保留class＃方法标志吗？

Answer 1

首先，你应该删除原来的Eclipse模板，因为它只是嘈杂的垃圾。 要么把有意义的文件放进去，要么根本不放。 但使用IDE模板的无用的重述只是混淆了代码。

其次，如果您需要生成javadoc，那么您必须以/**开头，否则不是javadoc。

最后，如果你重写，那么你应该使用@inheritDoc （假设你想添加到原始文档，如@seh指出，如果你只是想复制原始文档，那么你不需要任何东西）。 @see应该只能用来引用其他相关的方法。