是否可以为重载方法获得相同的文档？答案

【问题标题】：Is it possible to get the same doc for overloaded methods?是否可以为重载方法获得相同的文档？
【发布时间】：2013-06-14 09:49:33
【问题描述】：

我正在寻找使用重载方法制作文档的最佳方法。

我有两种方法：

/**
* does something
* @param A
* @return result
*/
public String methodA(Type1 A);

/**
 * does something
 * @param A
* @return result
*/
public String methodA(Type2 A);

由于这两种方法都呈现相同的东西，是否可以将文档集中在一个接受 Object 参数的方法上？或者有更好的方法吗？

【问题讨论】：

你说的是javadoc吗？
你可以使用泛型，但我想这对于集中文档来说有点笨拙！
@ Shreyos Adikari 是的，使用 JUnit。
Javadoc 没有这样的机制，没有...必须检查方法参数。
您可以使用stackoverflow.com/questions/5915992/… @link 标签将其中一种方法链接到另一种方法。这避免了实际文档的冗余（“做某事”）。

标签： java javadoc overloading

【解决方案1】：

我认为您编写一种“通用”文档的初衷并不是开箱即用的。你至少需要注意参数和返回值。

或者有更好的方法吗？

为避免实际文档的冗余，您可以使用@link 标签。

如果方法需要大量文档，例如 Properties.load() 方法，这将特别有用。

【讨论】：