Подробности разницы между @see и @inheritDoc

Я посмотрел ссылка JavaDoc и хотя я понимаю, основное различие между @see (разные ссылки) и {@inheritDoc} (экспорт комментария javadoc суперкласса), мне нужно разъяснение о том, как все на самом деле реализовано.

в Eclipse IDE, когда я выбираю "генерировать комментарии элементов" для унаследованного метода (из интерфейса или переопределения toString() и т. д.), Он создает следующий комментарий

/* (non-Javadoc)
 * @see SomeClass#someMethod()
 */

если я должен произвести JavaDoc если я оставлю это на этом, замените @see С {@inheritDoc}, или включите его в bona fide JavaDoc как таковой:

/**
 * {@inheritDoc}
 */

и когда я это сделаю, должен ли я все еще держать флаг класса#method?

70
commenting java javadoc

1 ответов

прежде всего, вы должны удалить исходный шаблон eclipse, потому что это просто шумный мусор. Либо поместите значимые документы, либо вообще ничего не кладите. Но бесполезное повторение очевидного с помощью шаблонов IDE просто загромождает код.

во-вторых, если вы обязаны производить javadoc, то вы есть чтобы сделать комментарий начать с /**. В противном случае, это не документация.

наконец, если вы переопределяете, то вы должны использовать @inheritDoc (Если вы хочу добавить к исходным документам, как отметил @seh в комментарии, если вы просто хотите дублировать исходные документы, то вам ничего не нужно). @see следует использовать только для ссылки другое связанные методы.

110