Подтвердить что ты не робот

Добавить новый JavaDoc к существующему из супер метода

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

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

/**
 * {@inheritDoc}
 */

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

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

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

EDIT:

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

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

4b9b3361

Ответ 1

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

/**
 * Enhanced swing paint for my cool component.
 * @see JButton#paint();
 */
@Override
public void paint() {
    super.paint();
    //my stuff
}

Ответ 2

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