Javadoc 是一个实现外部接口(interface)的类，但该接口(interface)不是您为其编写源代码的类？

Question

关闭。这个问题是 opinion-based 。目前不接受答案。

---

想要改进这个问题吗？更新问题，以便 editing this post 可以用事实和引文来回答它。 .

已关闭 5 年前。

Improve this question

如果我的类从外部库实现了一个记录良好的外部接口(interface)(我没有编写过)，例如 AttributeConverter来自javax.persistence ，我想知道记录我的重写方法的正确方法。我是否使用 @inheritDoc 或非 javadoc 注释 block ，或者根本不使用文档，因为可以轻松找到文档，正确的方法是什么？

Answer 1

这取决于您想要做什么。您必须问自己的第一个问题是:我需要向父级 Javadoc 添加一些内容吗？

如果答案是“否”，则这是基于意见的。如果您忽略它，只要您使用@Override，就会使用父级Javadoc。对于结果而言，non-javadoc 注释变得不必要。它在源代码中仍然发挥其作用。请参阅Should I use a "non-Javadoc" comment?

@inheritDoc 在这种情况下没有那么有用，因为它只复制它所使用的元素。来自 documentation :

Insert the inline tag {@inheritDoc} in a method main description or @return, @param or @throws tag comment -- the corresponding inherited main description or tag comment is copied into that spot.

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