спецификации, руководства, описания, API

Технология Javadoc

Javadoc является инструментом, который анализирует объявления и комментарии для документации в ряде исходных файлов и производит ряд страниц HTML, описывающих классы, интерфейсы, конструкторов, методы, и поля.

Можно использовать Javadoc doclet, чтобы настроить вывод Javadoc. doclet является программой, записанной с API Doclet, который определяет контент и формат вывода, который будет сгенерирован инструментом Javadoc. Можно записать doclet, чтобы генерировать любой вид вывода текстового файла, такого как HTML, SGML, XML, RTF, и MIF. Sun™ обеспечивает "стандарт" doclet для того, чтобы он генерировал документацию API формата HTML и экспериментальный MIF doclet для того, чтобы генерировать MIF, PDF, FrameMaker, и другие форматы. Doclets может также использоваться, чтобы выполнить специальные задачи, не связанные с созданием документации API.

taglet является программой, которая позволяет Вам создавать и использовать пользовательские теги, которые более гибки чем пользовательские теги, создаваемые с - опция тега. Пользовательский тег используется doclet, чтобы отформатировать и вывести на экран текст от тега Javadoc. taglet должен реализовать интерфейс taglet.

Спецификация API

API Doclet - Документация для пакета com.sun.javadoc, который включает API Doclet.
API Taglet - Документация для com.sun.tools.doclets.Taglet class, который включает API Taglet.

Инструменты

Следующие страницы перечисляют все теги javadoc и параметры командной строки для того, чтобы выполнить инструмент Javadoc с примерами для Соляриса и Microsoft Windows.

Учебные руководства и Руководства Программиста

Информация о Doclet:

Краткий обзор Doclet - Введение в doclets с простыми примерами, которые иллюстрируют API Doclet.
Выполняя Стандартный Doclet - Этот doclet производит значение по умолчанию отформатированная HTML документация API. Джейвэдок использует стандарт doclet, если никакой другой doclet не определяется с опцией -doclet Джейвэдока.
Переход к 5.0 API Doclet - Подсказки, чтобы расширить наследство doclets, чтобы поддерживать 5.0 новых функций языка.

Информация о Taglet:

Краткий обзор Taglet - Введение в taglets с простыми примерами, которые иллюстрируют API Taglet.

Улучшения API

Больше информации

Расположенный в Java™ SE Документация:

Осуждение в API

Расположенный на веб-сайте программного обеспечения Java:

FAQ Javadoc - Важные подсказки и обходные решения для ошибок.
Форум Javadoc - Вводит в обсуждения с поддерживающими разработчиками. Щелкните "по категории" Инструмента Javadoc. Этот форум контролируется только иногда командой Javadoc.

Свяжитесь с Нами