如何将方法的Javadoc复制到其他方法的Javadoc中？

Question

我知道有@inheritDoc，但它只适用于覆盖其他方法。

我有几个类有很多委托方法（不覆盖其他方法）。

他们的Javadoc可以“继承”（更确切地说：复制）吗？

/** here I need the copy of wrappedMethod's Javadoc */
public void delegateMethod(Object param){
  innerSomething.wrappedMethod(param);
}

Answer 1

@link或@see标签在这里是合适的。如果你正在包装方法，它必须提供独特的行为，使其不适合超载或其他方式。

Answer 2

有时剪切和粘贴文档实际上是件好事。以某种方式“链接”文档，特别是当没有继承关系时，会冒一个方法会以某种方式更改其行为的风险，使链接的文档不再有效。

然而，在代表的情况下，我多次遇到同样的问题。通常，在主类上委托一个包私有委托有一个公共方法，它与main方法具有完全相同的行为。这里的解决方案很简单 - 记录主类，并将@link或@see放在委托类上。每个人都可以看到主类的文档。您可能还需要在委托类中获得更详细的文档，例如实现细节。