Создание документации по Java

Этот мастер позволяет запустить интерфейс создания документации по Java. Это пользовательский интерфейс инструмента javadoc.exe, содержащегося в Java JDK. Полная документация по инструменту javadoc приведена на странице Sun's Javadoc Tool.

Первая страница

Выбор типа:

Опция

Описание

Выбрать типы, для которых будет создана документация по Java

В списке поставьте или удалите отметки с переключателей, указав в точности те типы, которые нужно экспортировать в файл JAR. Этот список инициализируется при выборе рабочей среды. За один раз можно выбрать только один проект, поскольку при работе с инструментом Javadoc в каждый момент можно использовать только один путь к классам проекта.

Создать документацию по Java для элементов с областью доступа:

  • Private: документация будет создана для всех элементов
  • Package: документация будет создана только для элементов с областью доступа default, protected или public
  • Protected: документация будет создана только для элементов с областью доступа protected или public
  • Public: документация будет создана только для элементов с областью доступа public (значение по умолчанию)


Применять стандартный доклет

Запустить команду Javadoc со стандартным доклетом (значение по умолчанию) 

  • Целевое расположение: выберите целевое расположение, в которое стандартный доклет будет записывать создаваемую документацию. Целевое расположение - это специальный аргумент доклета, поэтому он не применяется в случае пользовательского доклета.


Применять пользовательский доклет

Применять пользовательский доклет для создания документации 

  • Имя доклета: полное имя доклета с указанием его типа
  • Путь к классам доклета: путь к классам, необходимый классу доклета


Стандартные аргументы доклета

Стандартные аргументы доклета (доступно, если выбрана опция Применять стандартный доклет):

Опция

Описание

Заголовок документа

Укажите заголовок документа.
Создать страницу применения Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Применение.
Создать дерево иерархии Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Дерево.

Создать панель навигации

Выберите эту опцию, если вы хотите, чтобы документация содержала панель навигации (верхний и нижний колонтитулы).
Создать индекс Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Индекс.
Создать индекс по буквам Позволяет создать индекс по буквам. Доступна при выбранной опции Создать индекс.  
@author Выберите эту опцию, если вы хотите, чтобы тег @author документировался.
@version Выберите эту опцию, если вы хотите, чтобы тег @version документировался.
@deprecated Выберите эту опцию, если вы хотите, чтобы тег @deprecated документировался.
список устаревших Выберите эту опцию, если вы хотите, чтобы документация содержала страницу Устаревшие. Доступна при выбранной опции @deprecated.
Выбрать упоминаемые классы, на которые Javadoc должна создать ссылки Укажите, на какие разделы прочей документации должна создать ссылки команда Javadoc, если упоминаются другие типы.  
  • Выбрать все: создать ссылки на все остальные расположения документации
  • Очистить все: не создавать ссылки на другие расположения документации
  • Настроить: настроить расположение Javadoc упоминаемого файла JAR или проекта.
Лист стилей Выберите лист стилей, который нужно применять

Общие аргументы

Общие опции Javadoc:

Опция

Описание

Обзор

Указывает, что Javadoc должна извлекать текст обзорной документации из заданного файла. Текст будет помещен в overview-summary.html.

Дополнительные опции Javadoc

Добавить здесь произвольное число дополнительных опций: опции пользовательских доклетов, опции VM или опции совместимости JRE 1.4.
Обратите внимание, что аргументы, содержащие пробелы, необходимо заключать в кавычки. В аргументах, задающих html-код (например, -header), указывайте   или ", чтобы избежать пробелов и кавычек.

Сохранить параметры этого экспорта Javadoc в качестве сценария Ant

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

Открыть созданный файл индекса в браузере Открывает созданный файл index.html в браузере (доступна только в случае стандартного доклета)

Нажмите Готово, чтобы начать создание документации с помощью Javadoc. Если целевое расположение отличается от того, что указано на странице Расположение Javadoc проекта, то вам будет предложено подтвердить его. В случае утвердительного ответа, при всех запусках команды Открыть внешнюю Javadoc будет применяться вновь созданная документация.

Будет запущен новый процесс создания, который будет выполняться в фоновом режиме. Для просмотра информации о состоянии и ходе выполнения процесса создания откройте панель Консоль (Окно > Показать панель > Консоль).

Связанные задачи

Создание документации Javadoc

Связанные ссылки

Действия над файлами
Свойства расположения документации по Java