Метод переопределения документации Java не наследует Doc

метод, который переопределяет другой метод, не наследует документацию метода, который он переопределяет. Есть ли способ явно сказать ему, чтобы унаследовать документацию?

/**
  * {@inheritDoc}
  * 
  * This implementation uses a dynamic programming approach.
  */
@Override
public int[] a(int b) {
    return null;
}
16
documentation eclipse inheritdoc java

3 ответов

по словам документация javadoc:

наследование комментариев происходит во всех три возможных случая наследования из классов и интерфейсов:

  • когда метод в классе переопределяет метод суперкласса
  • когда метод в интерфейсе переопределяет метод в суперинтерфейсе
  • когда метод в классе реализует метод в интерфейсе

комментарии могут быть явно унаследованы с помощью {@inheritDoc} тег. Если для метода переопределения комментарии не предоставляются, комментарии неявно наследуются. Аспекты наследуемых комментариев(например, параметры, возвращаемое значение и т. д.) может быть отменен, если вы так хотите.

важно отметить, что вам нужно убедиться, что исходный файл, содержащий код с комментарием, который будет унаследован, доступен инструменту javadoc. Вы можете сделать это с помощью -sourcepath.

23

С руководство 1.4.2 Javadoc

алгоритм наследования комментариев метода - если метод не имеет комментария doc или имеет тег {@inheritDoc}, инструмент Javadoc ищет применимый комментарий, используя следующий алгоритм, который предназначен для поиска наиболее конкретного применимого комментария doc, отдавая предпочтение интерфейсам над суперклассами:

  1. посмотрите в каждом непосредственно реализованном (или расширенном) интерфейс в том порядке, в котором они появляются после слов реализует (или расширяет) в объявлении метода. Используйте первый комментарий doc, найденный для этого метода.
  2. если Шаг 1 не смог найти комментарий doc, рекурсивно примените весь этот алгоритм к каждому непосредственно реализованному (или расширенному) интерфейсу в том же порядке, в котором они были рассмотрены на шаге 1.
  3. если Шаг 2 не удалось найти комментарий doc, и это класс, отличный от Object (не интерфейс): 1. Если у суперкласса есть комментарий doc для этого метода, используйте его. 2. Если шаг 3a не смог найти комментарий doc, рекурсивно примените весь этот алгоритм к суперклассу.

Я считаю (хотя могу ошибаться), что этот базовый алгоритм все еще применяется к Java 1.5 и 1.6... хотя было бы очень мило со стороны Sun опубликовать полный автономный окончательный документ для каждой версии набора инструментов... Я думаю, это накладные расходы, которые они просто не могут себе позволить, по крайней мере для бесплатного набора инструментов.

Ура. Кит.

Edit:

вот быстрый и грязный пример.

код

package forums;


interface Methodical
{
  /**
   * A no-op. Returns null.
   * @param i int has no effect.
   * @return int[] null.
   */
  public int[] function(int i);
}


interface Methodological extends Methodical
{
  /**
   * Another no-op. Does nothing.
   */
  public void procedure();
}


class Parent implements Methodological
{
  @Override
  public int[] function(int i) {
    return null;
  }

  @Override
  public void procedure() {
    // do nothing
  }

}


class Child extends Parent
{
  /** {@inheritDoc} */
  @Override
  public int[] function(int i) {
      return new int[0];
  }

  /** {@inheritDoc} */
  @Override
  public void procedure() {
    System.out.println("I'm a No-op!");
  }

}


public class JavaDocTest
{
  public static void main(String[] args) {
    try {
      new Child().procedure();
    } catch (Exception e) {
      e.printStackTrace();
    }
  }
}

Javadoc

C:\Java\home\src\forums>javadoc -package -sourcepath . JavaDocTest.java
Loading source file JavaDocTest.java...
Constructing Javadoc information...
Standard Doclet version 1.6.0_12
Building tree for all the packages and classes...
Generating forums/\Child.html...
Generating forums/\JavaDocTest.html...
Generating forums/\Methodical.html...
Generating forums/\Methodological.html...
Generating forums/\Parent.html...
Generating forums/\package-frame.html...
Generating forums/\package-summary.html...
Generating forums/\package-tree.html...
Generating constant-values.html...
Building index for all the packages and classes...
Generating overview-tree.html...
Generating index-all.html...
Generating deprecated-list.html...
Building index for all classes...
Generating allclasses-frame.html...
Generating allclasses-noframe.html...
Generating index.html...
Generating help-doc.html...
Generating stylesheet.css...

производит файл:///C:/Java/главная/src/форумы/индекс.HTML-код

function

public int[] function(int i)

    A no-op. Returns null.

    Specified by:
        function in interface Methodical
    Overrides:
        function in class Parent

    Parameters:
        i - int has no effect. 
    Returns:
        int[] null.

procedure

public void procedure()

    Another no-op. Does nothing.

    Specified by:
        procedure in interface Methodological
    Overrides:
        procedure in class Parent
5

Swap @Override с помощью javaDoc.

    @Override
    /**
     * {@inheritDoc}
     */
-3