JavaDoc:减少同一类中重复方法描述的冗余

时间:2013-09-13 19:03:50

标签: java eclipse comments javadoc block-comments

例如,我有两个方法public Tree<T> addChild(final T data) {}public Tree<T> addChild(final T... data) {},它们的JavaDoc是相同的。如何将/** 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?非常感谢!

1 个答案:

答案 0 :(得分:2)

@see标签怎么样?它不是完全导入,而是放置引用:

/**
 * action 1 description
 */
public void action1(){}

/**
 * @see MyClass#action1
 */
public void action2(){}