java - 如何重用 javadoc 来实现类似的功能

Question

假设我有以下功能:

/**
 * Thorough explanation
 *
 */
public void somethingImportant(String parameter)
{
   (...)
}

现在为了方便起见，我添加以下功能:

public void somethingImportant()
{
   somethingImportant(null);
}

两个函数的 javadoc 应该几乎相同。也许唯一的区别是第一个函数有一个额外的行来描述 parameter 的作用。

有什么方法可以避免简单地复制现有的 javadoc，而是重用它？

Answer 1

使用@see标签并指向原始的、非重载的方法怎么样？然后在重载方法中你可以只使用@param值。

/**
*@see #yourMethod()
*/