@see与@inheritDoc区别详情
@see与@inheritDoc区别详情
提问于 2012-11-11 08:40:09
我已经看过JavaDoc reference了，虽然我理解@see (各种链接)和{@inheritDoc} (导出超类JavaDoc注释)之间的基本区别，但我需要澄清它是如何实际实现的。
在Eclipse IDE中，当我为继承的方法(从接口或toString()覆盖等)选择“生成元素注释”时，它会创建以下注释
/* (non-Javadoc)
* @see SomeClass#someMethod()
*/如果要求我生成JavaDoc，我应该将其替换为{@inheritDoc}，或者将其转换为真正的JavaDoc：
/**
* {@inheritDoc}
*/当我这样做的时候，我应该仍然保留class#method标志吗？
回答 1
Stack Overflow用户
回答已采纳
发布于 2012-11-11 09:01:35
首先，您应该删除原始的eclipse模板，因为它只是嘈杂的垃圾。要么放入有意义的文档，要么什么都不放。但是，重复那些显而易见的IDE模板只会使代码变得混乱。
其次，如果需要生成javadoc，则必须使注释以/**开头。否则，它就不是javadoc。
最后，如果你正在覆盖，那么你应该使用@inheritDoc (假设你想要添加到原始文档中，就像@seh在评论中指出的那样，如果你只是想复制原始文档，那么你不需要任何东西)。@see应该只用于引用其他相关的方法。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/13327534
复制相关文章
相似问题