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

java javadoc delegation

2022-09-01 07:50:28

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

我有几个类，其中包含许多委托方法（不覆盖其他方法）。

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

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

答案 1

此处适合使用@link或@see标记。如果要包装该方法，它必须提供独特的行为，使其不适合重载或其他方式。

答案 2

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

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