Javadoc - 如何复制函数描述?

2022-09-02 03:10:37

我有两个Java函数:

/**
* Do something with param
*/
public String doSomething(String param) {...};

/**
* ...
*/
public String doSomething(Integer param) {...};

如何使第二个函数的描述显示第一个函数的精确副本?


答案 1

假设复制和粘贴对您不起作用,我相信惯例是使用@see标签来引用另一种将提供更多细节的方法。

在您的示例中,doSomething(Integer param) 将具有一个引用字符串版本的 @see 标记。

维基百科有一些例子,http://en.wikipedia.org/wiki/Javadoc

javadoc工具的oracle站点也是如此 http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#multiple@see


答案 2

简短的答案是你不能。习惯是利用指令或简单地复制粘贴。@see

如果您正在子类化,则可以将javadoc放在接口级别以实现所需的目的。


推荐