如何为类似的函数重用javadoc

假设我有以下功能：

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

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

现在为了方便起见，我添加了以下函数：

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

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

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

参数

的作用

---

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

使用@see标记并指向原始的、未重载的方法呢？然后在重载方法中，您可以只使用@param值

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

---

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

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

---

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

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

---

作为旁白；如果所记录的方法是接口或覆盖的实现，则可以使用

{@inheritDoc}

标记。

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

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

---

作为旁白；如果您正在记录的方法是接口或覆盖的实现，那么您可以使用

{@inheritDoc}

标记。

我认为这取决于您的使用情况。如果使用javadoc创建docsite，那么@see应该可以。但是如果你将它们用于eclipse中的内联帮助，我会创建两个不同的javadoc条目。你想说什么？@popovitsj好吧，重用参数是重用Javadoc的一部分，仅此而已。@CiroSantilli但答案完全一样：使用

@see

注释。我认为这取决于你的使用情况。如果使用javadoc创建docsite，那么@see应该可以。但是如果你将它们用于eclipse中的内联帮助，我会创建两个不同的javadoc条目。你想说什么？@popovitsj好吧，重用参数是重用Javadoc的一部分，仅此而已。@CiroSantilli但答案完全相同：使用

@see

注释。如果类型/名称相同，我们只需要

@inheritMethod

，然后重用注释。也许一个插件应该可以工作。我们只需要

@inheritMethod

如果类型/名称相同，然后重用注释。也许一个插件可以工作。