将新的JavaDoc追加到super方法中的现有JavaDoc
我已经生成了一个非常有文档记录的接口。每个方法都有自己的JavaDoc。实现此接口的类在逻辑上几乎没有差异 如何将JavaDoc从超类添加到现有的JavaDoc中。关键词将新的JavaDoc追加到super方法中的现有JavaDoc,java,interface,methods,comments,javadoc,Java,Interface,Methods,Comments,Javadoc,我已经生成了一个非常有文档记录的接口。每个方法都有自己的JavaDoc。实现此接口的类在逻辑上几乎没有差异 如何将JavaDoc从超类添加到现有的JavaDoc中。关键词 /** * {@inheritDoc} */ 仅将超类的javaDoc设置为当前方法。但是当我尝试添加一些单词时,超级方法的JavaDoc消失了,比如 /** * {@inheritDoc} * These value depends on... */ 有人知道我如何更新超级方法的JavaDoc而不删除它吗 编辑
/**
* {@inheritDoc}
*/
仅将超类的javaDoc设置为当前方法。但是当我尝试添加一些单词时,超级方法的JavaDoc消失了,比如
/**
* {@inheritDoc}
* These value depends on...
*/
有人知道我如何更新超级方法的JavaDoc而不删除它吗
编辑:
关于Brian Agnew的答案,这是一个好答案,但不是真正的答案;)
当您希望覆盖现有方法(如Swing中的paint())并希望描述如何从外部初始化或处理绘制行为时,也可能会遇到相同的问题。
这不仅仅是为了接口描述。我不知道任何直接的JavaDoc习惯用法可以做到这一点。但是Eclipse和IntelliJ将允许您获取超级JDoc并插入它。。。这还远远不够完美,因为如果您更改supr JDoc,您将不得不重新编辑所有覆盖,但这比手动复制粘贴要好…我想当您需要向javadoc添加一些内容时,您更改了一些内容。因此,也许以完全相同的方式编写javadoc是正确的
/**
* Enhanced swing paint for my cool component.
* @see JButton#paint();
*/
@Override
public void paint() {
super.paint();
//my stuff
}
您描述的问题似乎在Java7中得到了解决。你建议的代码在那里运行得很好。问得好。今天我学到了一些非常有用的东西。非常适合编写接口文档,然后所有子级继承文档并向其中添加自己的内容-例如,一些实现可能会引发一些额外的异常,因此需要在Javadoc中添加单个
@throws
。