小编the*_*eUg的帖子

@see和@inheritDoc之间的差异细节

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

在Eclipse IDE中,当我为继承的方法选择"Generate Element Comments"时(从接口或toString()覆盖等),它会创建以下注释

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */
Run Code Online (Sandbox Code Playgroud)

如果我需要产生的JavaDoc我应该离开它,取代@see{@inheritDoc},或者把它真正的Javadoc这样的:

/**
 * {@inheritDoc}
 */
Run Code Online (Sandbox Code Playgroud)

当我这样做时,我是否应该保持类#方法标志?

java javadoc commenting

79
推荐指数
1
解决办法
6万
查看次数

标签 统计

commenting ×1

java ×1

javadoc ×1