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

Question

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

我有两种方法：

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

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

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

Answer 1

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

或者有更好的方法吗？

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

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