Javadoc - 如何复制功能描述？

Question

我有两个Java函数:

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

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

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

Answer 1

假设复制和粘贴不适合你,我相信惯例是使用@see标签来引用另一种方法,它将提供更多细节.

在您的示例中,doSomething(Integer param)将具有引用String版本的@see标记.

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

和javadoc工具的oracle站点一样http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#multiple@see

Answer 2

简短的回答是你不能.习惯是使用@see指令或简单地复制粘贴.

如果你是子类,你可以将javadoc放在接口级别上,而不是实现你想要的.

Answer 3

由于具有不同类型参数的两种方法不能具有相同的描述.但对于继承方法,我们可以使用相同的描述.

继承的方法

对于继承的方法,你可以使用

{@inheritDoc}

它从重写的方法复制描述.