Вопрос по java, javadoc – Написание правильного Javadoc с @see?

11

Как я могу использовать@see Javadoc правильно?

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

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

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

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

class MyImpl extends MyBase {

  /**
   * @see MyBase#myFunc()
   */
  @Override
  protected void myFunc() { .. }
}
Меня устраивает. Я могу навести курсор и F2 на MyImpl.myFunc и увидеть Javadoc, который я пишу на MyBase.myFunc. sudocode

Ваш Ответ

1   ответ
12

Для включения документации из суперкласса вы должны использовать{@inheritDoc} не@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) { .. }
}

Похожие вопросы