Написание собственного javadoc с помощью @see?

Как правильно использовать javadoc @see?

Мое намерение состоит в том, чтобы иметь абстрактный класс с абстрактными методами. Эти методы содержат комментарии javadoc. Теперь, если я расширяю абстрактный класс, я переопределяю методы и хочу использовать @see.

Но для всех параметров, например, для return ссылка @see не работает. Eclipse по-прежнему жалуется, что expected @return tag.

Итак, как я могу это использовать?

public abstract class MyBase {
  protected abstract void myFunc();
}

class MyImpl extends MyBase {

  /**
   * @see MyBase#myFunc()
   */
  @Override
  protected void myFunc() { .. }
}

Ответы

Ответ 1

Чтобы включить документацию из суперкласса, вы должны использовать {@inheritDoc} not @see.

Затем вы получите документы суперкласса. Вы можете добавить к нему, и вы можете переопределить такие вещи, как @param и @return, если вам нужно.

public abstract class MyBase {
  /**
   * @param id The id that will be used for...
   * @param good ignored by most implementations
   * @return The string for id
   */
  protected abstract String myFunc(Long id, boolean good);
}

class MyImpl extends MyBase {

  /**
   * {@inheritDoc}
   * @param good is used differently by this implementation
   */
  @Override
  protected String myFunc(Long id, boolean good) { .. }
}