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

java comments javadoc

2022-08-31 09:43:33

我已经查看了JavaDoc参考，虽然我了解（各种链接）和（导出超类JavaDoc注释）之间的基本区别，但我需要澄清事情是如何实际实现的。@see{@inheritDoc}

在Eclipse IDE中，当我为继承的方法选择“生成元素注释”（来自接口或toString（）覆盖等）时，它会创建以下注释

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

如果我被要求生成 JavaDoc，我应该把它留在那里，用替换，或者把它变成真正的 JavaDoc，如下所示：@see{@inheritDoc}

/**
 * {@inheritDoc}
 */

当我这样做时，我是否仍应保留 class#method 标志？

答案 1

首先，您应该删除原始的eclipse模板，因为它只是嘈杂的垃圾。要么放入有意义的文档，要么根本不放任何东西。但是，使用IDE模板对显而易见的无用重述只会使代码混乱。

其次，如果你被要求生成javadoc，那么你必须让注释以.否则，它不是javadoc。/**

最后，如果你正在覆盖，那么你应该使用（假设你想添加到原始文档，正如@seh评论中指出的那样，如果你只是想复制原始文档，那么你不需要任何东西）。应该只真正用于引用其他相关方法。@inheritDoc@see

答案 2