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

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

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

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

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

/**
 * {@inheritDoc}
 */

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

1 70
javascript javadoc commenting

1 ответ:

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

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

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

110