Комментарии к методам @Override - PullRequest
6 голосов
/ 06 июня 2011

Мой вопрос не является проблемой программирования ..

Я должен прокомментировать свой код для JavaDoc, но я думаю, что немного странно перекомментировать существующие методы (я думаю о @Override методах).

Например, я переопределяю метод onListItemClick, есть ли решение «перенаправить» пользователя на комментарий переопределенного метода?

Ответы [ 2 ]

13 голосов
/ 06 июня 2011

Использование: /** {@inheritDoc} */ или {@link package.class#member label}

http://download.oracle.com/javase/1.4.2/docs/tooldocs/windows/javadoc.html#{@inheritDoc}

8 голосов
/ 06 июня 2011

Попробуйте {@inheritDoc} атрибут.Это должно делать то, что вам нужно.

Вы также можете добавить дополнительные комментарии к справке после или до этого тега.Вот пример из исходного кода Android:

/**
 * {@inheritDoc}
 *
 * Note that if you're calling on a local binder, this always returns true
 * because your process is alive if you're calling it.
 */
public boolean isBinderAlive() {
    return true;
}
...