JavaDoc

Проработать

  1. Javadoc
  2. The Java API Documentation Generator
  3. How to Write Doc Comments for the Javadoc Tool

JavaDoc - инструмент для извлечения комментариев(HTML файлы). Является частью пакета JDK. По умолчанию обрабатываются только public и protected элементы программы. Для некоторых тегов необходимо указать их при запуске создания HTML файла чтобы они были добавлены в файл.

Основные разделы

Место записи

Над классом или методом в блоке комментария /** */

Примеры тегов

@see - ссылка на другие классы и методы. HTML документ использует описание с другого класса.

@version - информация о версии класса/метода.

@author - информация о создателе класса/метода.

@since - указывает версию проекта с которой этот код начал работать. Также используеться в документации JDK для указания версии JDK.

@param - для описания параметров метода.

@return - описание возвращаемого значения.

@throw - описание возможное возвращаемое исключение.

@deprecated - заставляет компилятор выдать предупреждение при использовании этого метода.