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

2023年4月21日 209次阅读

例如,我有两种方法,公共树< T> addChild(final T data){}和public Tree< T> addChild(final T … data){},它们的
JavaDocs完全相同.如何将/ **方法描述* /放在其中一个中,并使用标记将另一个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(){}
点赞