Наследование документации

Тег {@inheritDoc} позволяет скопировать текст документации из «предка».

Может быть использован в:

Основном блоке (описании)

В текстовых аргументах для методов:

@return

@param

@throws

Ссылки

Тег {@link} Вставляет ссылку на другой описанный элемент документации.

Полный синтакис:

{@link package.class#member label}

Синтаксис идентичен тегу @see. В отличии от @see данный тег вставляет ссылку прямо в текст, где он использован.

Пример:

Use the {@link #getComponentAt(int, int) getComponentAt} method.

Результат:

Use the getComponentAt method.

Ссылки {@linkplain}

Тег отличается от @{link} тем, что текст тег задает так же текст ссылки.

Пример:

Refer to {@linkplain add() the overridden method}.

Результат:

Refer to the overridden method.

Значение констант

Тег {@value} позволяет вставить в текст документации значения констант

Если тег используется без аргументов в описании статического поля (константы), то он заменяется значением константы

Пример:

/**

* The value of this constant is {@value}. */

public static final String SCRIPT_START = "<script>"

Аргумент тега задает ссылку на статическое поле другого класса аналогично тегу @see

Документирование пакетов

Пакеты документируются отдельным html файлом, название которого совпадает с названием пакета

package.html -> package-summary.html

Javadoc делает три вещи:

копирует все содержимое файла

Обрабатывает все теги @see, @since и {@link}

Копирует первое предложение в «краткую сводку» пакета

Использование картинок

Для использование картинок в документации необходимо следовать правилам:

Наименования. Название файла картинки должно быть: класс-число.тип. Пример: button-1.gif

Расположения. Файл должен располагаться в каталоге исходных файлов, в подкаталоге doc-files каталога, где располагается исходный файл.

Использование документации

•Документация может быть просмотрена браузером

•Документацию можно задать в Eclipse:

Расширение javadoc

Javadoc расширяется за счет:

Разработки собственных таглетов

Разработки собственных доклетов

Таглеты позволяют добавлять новые тэги

Доклеты позволяют изменять формат конечной документации

Расширение javadoc. Создание нового тега

Для создания нового тега необходимо создать класс, имплементирующий интерфейс com.sun.tools.doclets.taglet

Методы:

String getName()

boolean inConstructor()

boolean inField()

boolean inMethod()

boolean inOverview()

boolean inPackage()

boolean inType()

boolean isInlineTag()

String toString(com.sun.javadoc.Tag tag)

String toString(com.sun.javadoc.Tag[] tags)

public static void register (Map map)