java - 如何将一个方法的 Javadoc 复制到其他方法的 Javadoc 中？

Question

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

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

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

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

score 17 · Accepted Answer

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

score 9 · Accepted Answer

有时，剪切和粘贴文档实际上是一件好事。以某种方式“链接”文档，尤其是在没有继承关系的情况下，存在其中一种方法的行为会以某种方式改变的风险，从而使链接的文档不再有效。

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

2 回答 2