试问一个方法的Javadoc被复制到其他方法的Javadoc?
-
26-09-2019 - |
题
我知道有@inheritDoc
,但它只是对方法,其超越他人。
我有几类具有许多的委托强>方法(其做的不替换等)。
可以在他们的Javadoc被 “继承”(更准确地:复制)?
/** here I need the copy of wrappedMethod's Javadoc */
public void delegateMethod(Object param){
innerSomething.wrappedMethod(param);
}
解决方案
一个或@link @see标签将在这里适当。如果你包装的方法,它必须提供与众不同的行为,这就使得它不超载或其他方式。
其他提示
有时,它实际上是一件好事,剪切和粘贴文件。 “链接”以某种方式的文件,尤其是当有没有继承关系,运行风险的方法之一,将有它的行为在某种程度上改变,使得链接的文档不再有效。
然而,在委托的情况下,我有同样的问题多次。通常你有一个主类委托给包私人代表,它具有完全相同的行为为主要手段的公共方法。在这里,解决方法很简单 - 文件主类,并把@link或@see的委托类。大家可以看到主类的文档。你可能会需要有更详细的文档,如实施细则,对委托类了。
不隶属于 StackOverflow