JavaDoc:减少同一类中重复方法描述的冗余
例如,我有两个方法,JavaDoc:减少同一类中重复方法描述的冗余,java,eclipse,comments,javadoc,block-comments,Java,Eclipse,Comments,Javadoc,Block Comments,例如,我有两个方法,publictreeaddchild(finaltdata){}和publictreeaddchild(finaltdata){},它们的javadoc是相同的。如何将/**methoddescription*/放在其中一个JavaDoc中,并使用标记将另一个JavaDoc引用到前一个JavaDoc 就概念而言,就像: /** * method description */ public Tree<T> addChild(final T data) { ...
publictreeaddchild(finaltdata){}
和publictreeaddchild(finaltdata){}
,它们的javadoc是相同的。如何将/**methoddescription*/
放在其中一个JavaDoc中,并使用标记将另一个JavaDoc引用到前一个JavaDoc
就概念而言,就像:
/**
* method description
*/
public Tree<T> addChild(final T data) { ... }
/**
* @theTag #addChild(Object)
*/
public Tree<T> addChild(final T... data) { ... }
/**
*方法描述
*/
公共树addChild(最终T数据){…}
/**
*@theTag#addChild(对象)
*/
公共树addChild(最终T…数据){…}
如果我没记错的话,有一次我偶然发现了一个标记,它导入了Java原生API方法的整个方法描述。所以,这应该是可能的
什么是标签?非常感谢 看标签怎么样?它不是很重要,而是放置了一个引用:
/**
* action 1 description
*/
public void action1(){}
/**
* @see MyClass#action1
*/
public void action2(){}
谢谢你的回答。但是
@see
只是在泡沫中有一个链接。这还不够好:-/恐怕在纯javadoc中没有更好的了。只有{@inheritDoc}复制整个描述,但它仅适用于已实现或重写的方法。哦,是的!!我遇到的是/*(非Javadoc)*@see java.lang.Object#equals(java.lang.Object)*/@Override public boolean equals(Object obj){…}
。我刚刚尝试了一段时间,它似乎只适用于继承的方法,正如您所说。您可能在想,如果@inheritDoc
,它不符合您的要求。