Spec-Zone .ru
спецификации, руководства, описания, 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

Инструменты

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

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

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

Улучшения API

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

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

Oracle и/или его филиалы Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.
Свяжитесь с Нами