例如,我有两个方法,public Tree<T> addChild(final T data) {}
和public Tree<T> addChild(final T... data) {}
,它们的JavaDocs是相同的。如何将/** method description */
放在其中一个中,并使用标签将另一个JavaDoc引用到前一个?
就像,在概念上:
/**
* method description
*/
public Tree<T> addChild(final T data) { ... }
/**
* @theTag #addChild(Object)
*/
public Tree<T> addChild(final T... data) { ... }
如果我没记错的话,我曾经偶然遇到一个标签,它导入了 Java 原生 API 方法的整个方法描述。所以,这应该是可能的。
什么是@theTag
?非常感谢!
@see标签怎么样?它不是完全导入,而是放置一个引用:
/**
* action 1 description
*/
public void action1(){}
/**
* @see MyClass#action1
*/
public void action2(){}