Question

我查看了JavaDoc reference，虽然我理解@see（各种链接）和{@inheritDoc}（超类JavaDoc评论的导出）之间的基本区别，但我需要澄清事情的实际情况实现。

在Eclipse IDE中，当我为继承的方法选择“Generate Element Comments”时（从interface或toString（）覆盖等），它会创建以下注释

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

如果我需要生成JavaDoc，请将其保留，请将@see替换为{@inheritDoc}，或将其转换为真正的 JavaDoc：

/**
 * {@inheritDoc}
 */

当我这样做时，我是否仍应保留＃method方法标志？

Answer 1

首先，你应该删除原始的eclipse模板，因为它只是嘈杂的垃圾。要么放入有意义的文档，要么根本不放任何东西。但是使用IDE模板进行明显的无用重述只会使代码变得混乱。

其次，如果您需要生成javadoc，那么有使评论以/**开头。否则，它不是javadoc。

最后，如果你要覆盖，那么你应该使用@inheritDoc（假设你想添加到原始文档，如@seh在评论中注明，如果你只想复制原始文档，那么你不需要任何东西）。 @see应该仅用于引用其他相关方法。