Question

我正在使用Eclipse。我希望显示在重写方法中的注释。

这是一个例子 -

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

这可能吗？

Answer 1

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

Answer 2

我认为你不能真正拥有单个枚举常量方法的Javadoc。

因此，要么将重要信息放入一般方法（即Foo.bar），要么将其放入单个常量的文档中（即Foo.ITEM）。个别常量的方法不应该不同，因为它们需要单独的评论。

Answer 3

如果我理解你想要什么，这就是{@inheritDoc}的用途。将它放在注释主体或适当的标记中以从超类/接口声明中获取注释。

Source及相关摘录：

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

自动继承评论以填写缺失的文本 - 当主要   a，缺少描述或@return，@ param或@throws标记   方法注释，Javadoc工具复制相应的main   描述或标记来自它覆盖或实现的方法的注释   （如果有的话），根据下面的算法。更具体地说，当一个   缺少特定参数的@param标记，然后是注释   该参数是从继承的进一步向上复制的方法   层次结构。当缺少特定异常的@throws标记时   只有在声明了该异常时才会复制@throws标记。

这种行为与版本1.3及更早版本形成鲜明对比   存在任何主要描述或标记将阻止所有评论   从继承。

使用{@inheritDoc}标记明确继承评论 - 插入内联   在方法主要描述中标记{@inheritDoc}或@return，@ param或   @throws标记注释 - 相应的继承主要描述或   标记注释被复制到该位置。

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

3 个答案: