将新的 JavaDoc 附加到超级方法中的现有 JavaDoc

interface methods java comments javadoc

2022-09-01 23:41:54

我生成了一个界面，该界面有很好的文档记录。每个方法都有自己的JavaDoc。实现此接口的 clase 在逻辑上几乎没有区别。

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

/**
 * {@inheritDoc}
 */

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

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

有没有人知道如何更新超级方法的JavaDoc，而不删除。

编辑：

关于布莱恩·阿格纽的答案，这很好，但不是真正的答案;)

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

答案 1

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

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

答案 2

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