如何使重写方法中的javadoc注释可见

我正在使用Eclipse。我希望在重写的方法中发表的评论来代替。如何使重写方法中的javadoc注释可见

下面是一个例子 -

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特定参数

这可能吗？

来源

2011-09-23 mrkhrts

我不认为你真的可以拥有单独的枚举常量方法的Javadocs。

因此，要么将重要信息纳入一般方法（即Foo.bar），要么纳入个别常数（即Foo.ITEM）的文档中。个别常量的方法不应该有所不同，以至于无论如何都需要个人意见。

来源

2011-09-23 14:33:51

我想我必须为此解决，谢谢。 – mrkhrts

如果它是一个接口，将javadoc添加到接口，然后使用@Override标记，它应该显示出来。

来源

2011-09-23 14:27:06

如果我明白你想要的是正确的，这就是{@inheritDoc}的用途。将其放在评论主体或适当的标签中以获取超类/接口声明的评论。

Source和相关摘录：

法的自动复制评论Javadoc工具有下复制或“继承”的类方法的意见和接口的以下两种情况的能力。构造函数，字段和嵌套的类不会继承doc注释。

自动继承注释，以填补缺失的文本 - 当主描述或@return，@param或抛出：标签是从方法评论，Javadoc工具拷贝相应的主说明或标签的评论失踪根据下面的算法，它覆盖或实现（如果有的话）的方法。更具体地说，当针对特定参数的@param标记缺失时，则该参数的注释将从继承层次结构的继承层级中复制。如果缺少特定异常的@throws标记，则只有在声明了该异常的情况下，才会复制@throws标记。

此行为与1.3版和更早版本形成对比，其中任何主要描述或标记的存在都会阻止所有注释被继承。

明确继承与{@inheritDoc}标签注释 - 插入在方法主要描述或@return，@参数或 @throws标记注释内嵌标签{@inheritDoc} - 相应的继承主说明或标签评论被复制到那个地方。

来源

2011-09-23 15:30:48

如何使重写方法中的javadoc注释可见

回答

相关问题