我查看了JavaDoc参考,并且虽然了解了@see
(各种链接)和{@inheritDoc}
(超类JavaDoc注释的导出)之间的基本区别,但是我需要澄清事情的实际实现方式。
在Eclipse IDE中,当我为继承的方法(从接口或toString()重写,等等)选择“生成元素注释”时,它将创建以下注释
/* (non-Javadoc)
* @see SomeClass#someMethod()
*/
如果需要生成JavaDoc,我应该保留它,替换@see
为{@inheritDoc}
,或将其变成真正的JavaDoc,例如:
/**
* {@inheritDoc}
*/
当我这样做时,是否仍应保留class#method标志?
@inheritDoc
在打算添加到原始超类文档中时才应使用。如果您只是希望复制它,Javadoc将已经这样做,请注意,超类文档适用于子类的重写方法,因为该子类未提供其他文档。