Какова цель тегов Eclipse - таких как @author, @version, @link?

Question

Я заметил, что Eclipse автоматически добавляет тег @author с моим именем в начале нового класса Java. Я также заметил, что доступны другие теги, такие как @version, @link, @code, @value, @see ...

Это просто еще одно «соглашение», которое сформировалось так, что код остается хорошо документированным? Или есть какая-то другая цель?

Я пытался найти веб-сайт, который дал бы лучшее описание тегов и их использования, но мне не повезло.

Answer 1

Это теги Javadoc, связанные с механизмом Javadoc. Когда вы создадите Javadoc (для этого есть опция в меню Eclipse), эти ссылки будут интерпретированы соответствующим образом, а Javadoc будет более детальным. См. Ссылку в комментарии для получения списка всех доступных тегов.

Недооценивать силу документации вы не будете.