Javadoc是一个实现外部接口的类，而不是您编写源代码的外部接口？

Question

如果我的类从外部库（我还没写过）中实现了一个记录良好的外部接口，例如来自AttributeConverter的{​​{1}}，我想知道正确的方法来记录我的覆盖方法。我是否使用@inheritDoc或非javadoc注释块，或者根本没有文档，因为可以轻松找到文档，正确的方法是什么？

Answer 1

这取决于你想要做什么。你要问自己的第一个问题是：我有没有东西要添加到父母Javadoc？

如果答案是＆＃34; no＆＃34;，这是基于意见的。如果您将其删除，只要您使用@Override，就会使用父母Javadoc。关于结果，non-javadoc评论变得无关紧要。它仍然在源代码中起到了它的作用。见Should I use a "non-Javadoc" comment?

在这种情况下，

@inheritDoc不是很有用，因为它只复制它所使用的元素。来自documentation：

  

在方法主要说明或@return，@ param或@throws标记注释中插入内联标记{@inheritDoc} - 将相应的继承主要描述或标记注释复制到该位置。

如果您想在父母文档中添加内容，它就会发挥作用。使用它在您自己的评论中的某个位置插入父文档。