如何使重写方法中的javadoc注释可见
我正在使用Eclipse。我希望改为显示在重写方法中所做的注释 这里有一个例子-如何使重写方法中的javadoc注释可见,java,eclipse,enums,overriding,javadoc,Java,Eclipse,Enums,Overriding,Javadoc,我正在使用Eclipse。我希望改为显示在重写方法中所做的注释 这里有一个例子- enum Foo{ ITEM{ /** * Arguments must be received in the following order... */ @Override void bar(String[] args){...} }; /** * Bars the specific ar
enum Foo{
ITEM{
/**
* Arguments must be received in the following order...
*/
@Override
void bar(String[] args){...}
};
/**
* Bars the specific args
* @param args the specific args
*/
abstract void bar(String[] arags);
}
当我有如下Foo.ITEM.bar(…)
之类的东西,并且我将鼠标悬停在上面时,我想阅读
条带特定参数必须按以下顺序接收参数…
@args指定特定的args
这是可能的吗?如果它是一个接口,请将javadoc添加到接口中,然后使用@Override标记,它应该会显示出来。我认为您不能为单个枚举常量的方法使用javadoc
因此,要么将重要信息放入通用方法(即
Foo.bar
),要么放入单个常量的文档(即Foo.ITEM
)。单个常量的方法不应该有太大的不同,它们需要单独的注释。如果我正确理解您的要求,这就是{@inheritDoc}
的用途。将其放置在注释主体或适当的标记中,以从超类/接口声明中获取注释
和相关摘录:
Javadoc工具具有自动复制方法注释的功能
在下面的类和接口中复制或“继承”方法注释
以下两种情况。构造函数、字段和嵌套
类不继承文档注释
自动继承注释以填充缺少的文本-当主
说明或@return、@param或@throws标记在
方法注释,Javadoc工具复制相应的主
来自其重写或实现的方法的说明或标记注释
(如有),根据以下算法。更具体地说,当
@缺少特定参数的param标记,则缺少
该参数是从继承之后的方法复制的
等级制度当特定异常的@throws标记丢失时,
仅当声明了该异常时,@throws标记才会被复制
此行为与版本1.3及更早版本形成对比,其中
任何主要描述或标签的存在都会阻止所有评论
避免被继承
使用{@inheritDoc}标记显式继承注释-插入内联
方法主描述或@return、@param或
@抛出标记注释--相应的继承主描述或
标记注释被复制到该位置