Подробная информация о различиях между @see и @inheritDoc
Я просмотрел ссылку JavaDoc, и хотя я понимаю основную разницу между @see (различные ссылки) и {@inheritDoc} (экспорт комментариев Java-класса суперкласса) Мне нужно разъяснить, как реально реализованы вещи.
В Eclipse IDE, когда я выбираю "Generate Element Comments" для унаследованного метода (от переопределения интерфейса или toString() и т.д.), он создает следующий комментарий
/* (non-Javadoc)
* @see SomeClass#someMethod()
*/
Если мне необходимо создать JavaDoc, я должен оставить его на этом, замените @see на {@inheritDoc} или включите его в bona fide JavaDoc как таковой:
/**
* {@inheritDoc}
*/
И когда я это сделаю, должен ли я сохранить флаг метода класса #?
Ответы
Ответ 1
Прежде всего, вы должны удалить исходный шаблон затмения, потому что это просто шумный хлам. либо помещать значимые документы, либо ничего не ставить. но бесполезное повторение очевидного с использованием шаблонов IDE просто загромождает код.
second, если вам нужно создать javadoc, тогда вы должны сделать комментарий с /**, иначе это не javadoc.
Наконец, если вы переопределяете, вы должны использовать @inheritDoc (при условии, что вы хотите добавить в исходные документы, как отметил @seh, если вы просто хотите дублировать оригинальные документы, то вам ничего не нужно), @see следует использовать только для ссылки на другие связанные методы.
