@see和@inheritDoc之间的区别有什么?

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (1)
  • 关注 (0)
  • 查看 (48)

虽然理解@see(各种链接)和{@inheritDoc}(超类JavaDoc评论的导出)之间的基本区别,但我需要澄清事情是如何实际执行的。

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

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

如果我被要求生成JavaDoc,那么我应该放弃它,替换@see真正的 JavaDoc {@inheritDoc},或者将它转换为JavaDoc:

/**
 * {@inheritDoc}
 */

当我这样做时,是否还应该保留class#方法标志?

提问于
用户回答回答于

首先,你应该删除原来的Eclipse模板,要么放置有意义的文档,要么根本不放置任何东西。但对使用IDE模板的明显无用的重述只会使代码混乱。

其次,如果需要生成javadoc,那么必须开始评论/**,否则它不是javadoc。

最后如果你重写,那么应该使用@inheritDoc@see应该只用来引用其他相关的方法。

扫码关注云+社区

领取腾讯云代金券