从super方法将新JavaDoc附加到现有JavaDoc

时间:2009-04-02 13:13:39

标签: java interface methods comments javadoc

我已经生成了一个非常好的文档接口。每个方法都有自己的JavaDoc。实现此接口的条款在逻辑上几乎没有区别。

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

/**
 * {@inheritDoc}
 */

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

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

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

修改

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

如果要覆盖现有方法(例如Swing中的paint()),并且想要描述如何从外部初始化或处理绘制行为,则也会遇到同样的问题。 这不仅适用于界面描述。

2 个答案:

答案 0 :(得分:14)

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

/**
 * Enhanced swing paint for my cool component.
 * @see JButton#paint();
 */
@Override
public void paint() {
    super.paint();
    //my stuff
}

答案 1 :(得分:2)

我不知道任何直接的JavaDoc习惯用法。然而Eclipse和IntelliJ会让你抓住超级JDoc并插入它...它远非完美,就像你改变supr JDoc一样,你将不得不重新编写所有覆盖,但它比手工复制粘贴更好......