首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >Javadoc -如何复制函数描述?

Javadoc -如何复制函数描述?
EN

Stack Overflow用户
提问于 2011-03-30 17:17:13
回答 4查看 9.2K关注 0票数 21

我有两个Java函数:

代码语言:javascript
复制
/**
* Do something with param
*/
public String doSomething(String param) {...};

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

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

EN

回答 4

Stack Overflow用户

回答已采纳

发布于 2011-03-30 17:20:09

假设复制和粘贴对您不起作用,我相信约定是使用@see标记来引用另一种方法,它将提供更详细的信息。

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

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

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

票数 23
EN

Stack Overflow用户

发布于 2011-03-30 17:18:36

简单的回答是你不能,习惯上是使用@see指令或者简单的复制粘贴。

如果您正在进行子类化,则可以将javadoc放在接口级别上,以实现您想要的效果。

票数 9
EN

Stack Overflow用户

发布于 2011-03-30 17:36:09

因为具有不同类型参数的两个方法不能有相同的描述。但是对于继承的方法,我们可以使用相同的描述。

继承方法

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

{@inheritDoc}

它从被覆盖的方法中复制描述。

票数 6
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/5484375

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档