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

Question

我知道有

@inheritDoc

，但它仅适用于覆盖其他方法的方法。

我有几个类，其中有许多 delegate 方法（这些方法 not 覆盖其他方法）。

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

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

Answer 1

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

Answer 2

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

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

Answer 3

使用

@see

，您可以引用其他方法

/** 
 * @see #wrappedMethod(Object)
 */
public void delegateMethod(Object param){
  innerSomething.wrappedMethod(param);
}