Деталі різниці між @see та @inheritDoc

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

У середовищі Eclipse IDE, коли я вибираю «Створити коментарі до елементів» для успадкованого методу (від інтерфейсу або перевизначення toString () тощо), він створює такий коментар

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

Якщо я зобов'язаний плодоовочевого JavaDoc я повинен залишити його в цьому, замініть @seeз {@inheritDoc}, або перетворити його в сумлінному JavaDoc як такої:

/**
 * {@inheritDoc}
 */

І коли я це роблю, чи повинен я все ще зберігати прапор методу class #?

Перш за все, вам слід видалити оригінальний шаблон затемнення, тому що це просто галасливий мотлох. Або помістіть значущі документи, або взагалі нічого не розміщуйте. Але марне переглядання очевидних шаблонів IDE просто захаращує код.

По-друге, якщо від вас вимагається створення javadoc, тоді ви повинні зробити коментар з самого початку /**. В іншому випадку це не javadoc.

Нарешті, якщо ви перевизначаєте, то вам слід використовувати @inheritDoc(припускаючи, що ви хочете додати до оригінальних документів, як @seh зазначив у коментарі, якщо ви просто хочете продублювати оригінальні документи, тоді вам нічого не потрібно). @seeслід реально використовувати лише для посилання на інші суміжні методи.