23

我已经生成了一个有据可查的接口。每个方法都有自己的 JavaDoc。实现此接口的类在逻辑上可能略有不同。

如何将 JavaDoc 从超类添加到现有的 JavaDoc。关键词

/**
 * {@inheritDoc}
 */

只将超类的 javaDoc 设置为当前方法。但是当我尝试添加一些单词时,超级方法的JavaDoc就消失了,比如

/**
 * {@inheritDoc}
 * These value depends on...
 */

有谁知道我如何在不删除的情况下更新超级方法的 JavaDoc。

编辑:

关于 Brian Agnew 的回答,这很好但不是真正的答案;)

当您想要覆盖现有方法(如 Swing 中的 paint())并想要描述如何从外部初始化或处理绘制行为时,您也可能遇到同样的问题。这不仅仅用于接口描述。

4

2 回答 2

16

我想当你需要向 javadoc 添加一些东西时,你改变了一些东西。因此,以完全相同的方式编写 javadoc 可能是正确的。

/**
 * Enhanced swing paint for my cool component.
 * @see JButton#paint();
 */
@Override
public void paint() {
    super.paint();
    //my stuff
}
于 2010-02-08T09:32:57.467 回答
2

我不知道有任何直接的 JavaDoc 习语可以做到这一点。然而 Eclipse 和 IntelliJ 会让你抓取超级 JDoc 并插入它......它远非完美,就像你更改超级 JDoc 你将不得不重新编辑所有覆盖,但它比手动复制粘贴更好......

于 2009-04-02T17:27:03.063 回答