【发布时间】:2012-10-30 22:07:11
【问题描述】:
我查看了 JavaDoc reference,虽然我了解 @see(各种链接)和 {@inheritDoc}(超类 JavaDoc 注释的导出)之间的基本区别,但我需要澄清事情的实际实现方式。
在 Eclipse IDE 中,当我为继承的方法(从接口或 toString() 覆盖等)选择“生成元素注释”时,它会创建以下注释
/* (non-Javadoc)
* @see SomeClass#someMethod()
*/
如果我需要生成 JavaDoc,我应该把它留在那里,将 @see 替换为 {@inheritDoc},或者将其转入 真正的 JavaDoc 中:
/**
* {@inheritDoc}
*/
当我这样做时,我还应该保留 class#method 标志吗?
【问题讨论】: