我的问题不是一个编程问题。
我必须为JavaDoc注释我的代码,但我认为重新注释现有方法有点奇怪(我想到@Override
方法)。
例如,我重写了onListItemClick
方法,有没有办法“重定向”用户到被覆盖的方法的注释?
我的问题不是一个编程问题。
我必须为JavaDoc注释我的代码,但我认为重新注释现有方法有点奇怪(我想到@Override
方法)。
例如,我重写了onListItemClick
方法,有没有办法“重定向”用户到被覆盖的方法的注释?
使用:/** {@inheritDoc} */
或{@link package.class#member label}
http://download.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#{@inheritDoc}
尝试使用{@inheritDoc}
属性。这应该可以满足您的需求。
您还可以在此标签之前或之后添加一些额外的帮助注释。以下是来自Android源代码的示例:
/**
* {@inheritDoc}
*
* Note that if you're calling on a local binder, this always returns true
* because your process is alive if you're calling it.
*/
public boolean isBinderAlive() {
return true;
}
{@inheritDoc}
生效,继承类或接口的源代码必须包含在 javadoc 运行的 sourcepath 中。 - Paŭlo Ebermann