【发布时间】:2010-10-17 02:47:03
【问题描述】:
我已经生成了一个有据可查的接口。每个方法都有自己的 JavaDoc。实现此接口的类在逻辑上可能略有不同。
如何将 JavaDoc 从超类添加到现有的 JavaDoc。关键词
/**
* {@inheritDoc}
*/
只将超类的 javaDoc 设置为当前方法。但是当我尝试添加一些单词时,super方法的JavaDoc就不见了,就像
/**
* {@inheritDoc}
* These value depends on...
*/
有没有人知道如何在不删除的情况下更新超级方法的 JavaDoc。
编辑:
关于 Brian Agnew 的回答,这很好但不是真正的答案;)
当您想要覆盖现有方法(如 Swing 中的 paint())并想要描述如何从外部初始化或处理绘制行为时,您也可能会遇到同样的问题。 这不仅仅用于接口描述。
【问题讨论】:
-
您描述的问题似乎已在 Java 7 中得到解决。您建议的代码在那里运行良好。
-
好问题。我今天学到了一些非常有用的东西。非常适合记录接口,然后所有子级都继承文档并向其中添加自己的内容 - 例如,某些实现可能会引发一些额外的异常,因此需要在 Javadoc 中添加单个
@throws。
标签: java interface methods comments javadoc