如何重用javadoc用于类似的功能

Question

我们说我有以下功能：

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

为方便起见，我添加了以下功能：

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

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

有没有办法避免简单地复制现有的javadoc，而是重复使用它？

Answer 1

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

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

Answer 2

JavaDoc不支持这种功能。相反，我所做的是使用最多参数完全记录方法，然后链接我的默认方法：

/**
 * {@code parameter} defaults to null.
 *
 * @see MyClass#somethingImportant(String)
 */
public void somethingImportant()

撇开;如果您正在记录的方法是界面或覆盖的实现，则可以使用{@inheritDoc}标记。