Добавить новый JavaDoc к существующим из метода super - PullRequest
22 голосов
/ 02 апреля 2009

Я создал интерфейс, который очень хорошо задокументирован. Каждый метод имеет свой собственный JavaDoc. Предложения, которые реализуют этот интерфейс, могут иметь небольшие отличия в своей логике.

Как я могу добавить JavaDoc к существующему JavaDoc из суперкласса. Ключевое слово

/**
 * {@inheritDoc}
 */

только устанавливает javaDoc суперкласса для текущего метода. Но когда я пытаюсь добавить несколько слов, JavaDoc супер-метода исчезает, как

/**
 * {@inheritDoc}
 * These value depends on...
 */

Кто-нибудь знает, как я могу обновить JavaDoc супер-метода, не удаляя.

EDIT:

Относительно ответа Брайана Агнью, это хороший, но не реальный ответ;)

Вы также можете столкнуться с той же проблемой, когда хотите перезаписать существующий метод, например paint () в Swing, и хотите описать, как инициализировать или обрабатывать поведение при рисовании извне. Это не только для описания интерфейса.

Ответы [ 2 ]

14 голосов
/ 08 февраля 2010

Полагаю, что когда вам нужно что-то добавить в javadoc, вы что-то изменили. Так что, возможно, будет правильно написать javadoc точно так же.

/**
 * Enhanced swing paint for my cool component.
 * @see JButton#paint();
 */
@Override
public void paint() {
    super.paint();
    //my stuff
}
2 голосов
/ 02 апреля 2009

Я не знаю какой-либо прямой идиомы JavaDoc, которая делает это. Однако Eclipse и IntelliJ позволят вам взять супер JDoc и вставить его ... он далек от совершенства, как будто вы меняете supr JDoc, вам придется заново редактировать все переопределения, но это лучше, чем копировать-вставлять вручную ...

...