一个方法';s Javadoc可以复制到其他方法';是Javadoc吗?

一个方法';s Javadoc可以复制到其他方法';是Javadoc吗?,java,javadoc,delegation,Java,Javadoc,Delegation,我知道有@inheritDoc,但它只适用于覆盖其他方法的方法 我有几个类有许多委托方法(这些方法不会覆盖其他方法) 他们的Javadoc是否可以“继承”(更确切地说是复制) 一个@link或@see标签在这里是合适的。如果要包装该方法,它必须提供使其不适合重载或其他方式的独特行为 有时候剪切和粘贴文档实际上是件好事。”以某种方式链接“文档”,特别是在继承关系中没有链接的情况下,会有一种风险,即其中一种方法的行为会发生某种改变,从而使链接的文档不再有效 然而,就代表而言,我已经多次遇到同样的问题

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

我有几个类有许多委托方法(这些方法不会覆盖其他方法)

他们的Javadoc是否可以“继承”(更确切地说是复制)


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

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


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

是的,但是当包装的方法受到保护时,
@link
@see
显然没有用处:(
@seanizer
哦,我不知道这是可能的,谢谢!对于可见性低于生成对象的方法,这不起作用。对于库编写者来说,例如,不能使用私有成员生成JavaDoc。我想知道一种在公共API中重用私有文档的方法。@BennyBottema,你是表达我的想法,谢谢!我也遇到了这样的情况:我正在用一个相当广泛的Javadoc记录一个解析选项字符串的私有方法。这是描述的地方,但是几个构造函数传递了选项字符串,并且也需要相同的文本。如果现在我从私有方法复制文本,它跨越了如果一个或甚至每个构造函数都已经全屏显示,这将是一个多余的混乱和维护噩梦。我不想增加仅由构造函数调用的对象的方法可见性。密切相关但特别是重载方法:
/** here I need the copy of wrappedMethod's Javadoc */
public void delegateMethod(Object param){
  innerSomething.wrappedMethod(param);
}