java - @see 和 @inheritDoc 之间的区别的详细信息

Question

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

在 Eclipse IDE 中，当我为继承的方法（从接口或 toString() 覆盖等）选择“生成元素注释”时，它会创建以下注释

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

如果我需要生成 JavaDoc，我应该保留它，替换@see为{@inheritDoc}，或将其转换为真正的JavaDoc，如下所示：

/**
 * {@inheritDoc}
 */

当我这样做时，我还应该保留 class#method 标志吗？

score 156 · Accepted Answer

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

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

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

1 回答 1