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

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具体参数

这可能吗？

Answer 1

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

来源和相关摘录：

自动复制方法注释Javadoc工具有能力
复制或“继承”类和接口中的方法注释
以下两种情况。构造函数、字段和嵌套
类不继承文档注释。

自动继承注释来填充缺失的文本 - 当主
描述或@return、@param 或@throws 标签缺失
方法注释，Javadoc工具复制对应的main
来自它覆盖或实现的方法的描述或标记注释
（如果有的话），根据下面的算法。更具体地说，当
缺少特定参数的 @param 标记，则注释为
该参数是从继承的方法中复制的
等级制度。当特定异常的 @throws 标记丢失时，
仅当声明该异常时才会复制 @throws 标记。

此行为与 1.3 及更早版本形成对比，其中
任何主要描述或标签的存在都会阻止所有评论
免于被继承。

使用 {@inheritDoc} 标记显式继承注释 - 插入内联
方法主要描述中的标记 {@inheritDoc} 或 @return、@param 或
@throws标签注释——对应继承的主要描述或者
标签评论被复制到该位置。

Answer 2

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

因此，要么将重要信息放入通用方法（即 Foo.bar）中，要么将其放入单个常量的文档中（即 Foo.ITEM）。各个常量的方法不应该有太大的不同，以至于它们无论如何都需要单独的注释。

Answer 3

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