javafxdoc - Утилита Документации JavaFX

ИМЯ

javafxdoc - Утилита Документации JavaFX. Этот инструмент извлечения отформатированные комментарии, встроенные в файлы исходного кода JavaFX и, организуют и выводят на экран те комментарии в формате HTML.

Резюме

javafxdoc [options] [packagenames] [sourcefilenames] [-subpackages] pkg1:pkg2:... [@argfiles]

options
Параметры командной строки.
packagenames
Серия имен пакетов, разделенных пробелами, такой как javafx.lang javafx.xml или javafx.gui.effect. Следует отдельно определить каждый пакет, который Вы хотите задокументировать. Подстановочные знаки не позволяются. Использовать -subpackages для рекурсии. javafxdoc использование инструмента sourcepath искать эти имена пакета.
sourcefilenames
Серия имен исходного файла, разделенных пробелами, каждые из которых могут начаться с пути и содержать подстановочный знак, такой как звездочка (*). javafxdoc инструмент обрабатывает каждое имя файла, заканчивающееся .fx, где имя файла, лишенное того суффикса, является юридическим именем модуля (см. Идентификаторы). Поэтому, можно назвать файлы с тире (такой как X-Buffer), или другие запрещенные символы, чтобы препятствовать тому, чтобы они были задокументированы. Путь, который предшествует имени исходного файла, определяет где javafxdoc будет искать файл. ( javafxdoc инструмент не использует sourcepath искать эти имена исходного файла.) Относительные пути относительно текущего каталога, таким образом передавая в Button.fx идентично ./Button.fx. Например, имя исходного файла с абсолютным путем и подстановочным знаком /home/src/java/awt/Graphics*.fx.
subpackages
Генерирует документацию от исходных файлов в указанных пакетах и рекурсивно в их подпакетах. Альтернатива предоставлению имен пакета или имен исходного файла.
@argfiles
Файл параметра командной строки содержит список javafxdoc опции, packagenames и sourcefilenames, в любом порядке. Подстановочные знаки (*) и -J опции не позволяются в этих файлах.

Сократить или упростить javafxdoc командная строка, можно определить один или более файлов, которые непосредственно содержат параметры javafxdoc команда (кроме -J опции). Это позволяет Вам создать javafxdoc команды любой длины.

Параметры могут быть в любом порядке. См. Ссылки Обработки для деталей, объясняющих как javafxdoc инструмент определяет который файлы исходного кода обработать.

Описание

javafxdoc инструмент анализирует объявления и комментарии для документации в ряде исходных файлов Сценария JavaFX и производит соответствующий набор страниц HTML, описывающих (по умолчанию) общедоступные и защищенные классы, атрибуты, и функции. Можно использовать это, чтобы генерировать документацию Прикладного программного интерфейса или документацию реализации для ряда исходных файлов. Этот инструмент преднамеренно очень подобен Java javadoc инструмент.

Можно работать javafxdoc инструмент на всех пакетах, отдельных исходных файлах, или обоих. Документируя все пакеты, можно или использовать подпакеты для того, чтобы пересечь рекурсивно вниз из высокоуровневого каталога, или передать в явном списке имен пакета. Документируя отдельные исходные файлы, Вы передаете в списке источника (.fx) имена файлов.

Опции

-link extdocURL
Создает ссылки к существующей javadoc-сгенерированной документации внешних классов, на которые ссылаются.
-linkoffline extdocURL
Эта опция является изменением -link. Обе опции создают ссылки к javafxdoc-сгенерированной документации для внешних классов, на которые ссылаются. Используйте -linkoffline опция, соединяясь с документом о сети, когда javafxdoc сам инструмент является офлайновым, то есть, он не может получить доступ к документу посредством веб-подключения.
-subpackages package1:package2:...
Генерирует документацию от исходных файлов в указанных пакетах и рекурсивно в их подпакетах.
-sourcepath sourcepathlist
Определяет путь поиска для того, чтобы найти исходные файлы (.fx) передавая имена пакета или -subpackages в javafxdoc команда.
-profile [desktop | mobile | tv]
Определяет платформу JavaFX. SDK JavaFX поддерживает desktop, mobile, и tv и значения по умолчанию к desktop. Внутренне -profile опция, которая определяет конфигурационный файл, который используется для того, чтобы установить переменные окружения.
-version
Выводит на экран версию инструмента и выходы. Отметьте: Использовать -J-version получить версию платформы Java

Обработка Исходных файлов

javafxdoc инструмент обрабатывает файлы тот конец в .fx, плюс другие файлы, описанные под Исходными файлами. Если Вы работаете javafxdoc инструмент, явно передавая в отдельных исходных именах файлов, можно определить точно который .fx файлы обрабатываются. Однако, это не то, как большинство разработчиков хочет работать, поскольку более просто передать на имена пакета.

Можно работать javafxdoc три пути, явно не определяя исходные имена файлов:

В этих случаях, javafxdoc инструмент обрабатывает a .fx файл, только если его имя, после снятия изоляции .fx снабдите суффиксом, юридическое имя class. Для получения дополнительной информации см. Идентификаторы.

Во время выполнения, javafxdoc инструмент автоматически добавляет ссылки перекрестной ссылки к пакету, class и именам элемента, которые документируются как часть того выполнения. Ссылки появляются в нескольких местах:

Можно добавить гиперссылки к существующему тексту для классов, не включенных в командную строку (но сгенерированный отдельно) посредством link и linkoffline опции.

Другие Детали Обработки

javafxdoc инструмент представляет один полный документ каждый раз, когда это выполняется. Это не может сделать инкрементный, создает, то есть, это не может изменить или непосредственно бестелесные следствия предыдущих выполнений javafxdoc инструмент. Однако, это может соединиться со следствиями других выполнений, как отмечено выше. javafxdoc у инструмента также есть опция, чтобы сохранить промежуточные данные от ряда пакетов в XML-файле. Эти промежуточные файлы могут быть включены с a javafxdoc задача, чтобы включить предыдущие выполнения в полный документ.

Как реализовано, javafxdoc инструмент требует и полагается на компилятор Сценария JavaFX, чтобы сделать его задание. javafxdoc инструмент вызывает часть javafxc скомпилировать объявления, игнорируя задействованную реализацию. Это создает богатое внутреннее представление классов, включая иерархию class, и use отношения, затем генерирует HTML от этого. javafxdoc инструмент также поднимает предоставленную пользователем документацию из комментариев для документации в исходном коде.

Фактически, javafxdoc инструмент может работать .fx исходные файлы, которые являются чистыми тупиковыми файлами без тел метода. Это означает, что можно записать комментарии для документации и работать javafxdoc инструмент на ранних стадиях проекта, создавая API, прежде, чем записать реализацию.

Когда javafxdoc инструмент создает свою внутреннюю структуру для документации, он загружает все классы, на которые ссылаются. Из-за этого процесса, javafxdoc инструмент должен быть в состоянии найти все классы, на которые ссылаются, ли классы начальной загрузки, расширения, или пользовательские классы. Для больше об этом требовании, см., Как Классы Находятся. Вообще, классы, которые Вы создаете, должны или быть загружены как расширение или находиться в пути class для javafxdoc инструмент.

Комментарии для документации

javafxdoc у инструмента есть возможность скопировать или наследовать функциональные комментарии в классах. Отметьте, что атрибуты не наследовали комментарии документа.

Теги javafxdoc

javafxdoc инструмент анализирует специальные теги, когда они встраиваются в пределах комментария документа Сценария JavaFX. Эти теги документа позволяют Вам автоматически сгенерировать полный, хорошо отформатированный API от своего исходного кода. Теги запускаются со знака at sign и являются чувствительными к регистру: они должны быть введены с прописными и строчными буквами как показано. Тег должен запуститься в начале строки после любых ведущих пробелов и дополнительной звездочки, или он обрабатывается как нормальный текст. Условно, теги с тем же самым именем группируются. Например, поместите все @see теги вместе.

Текущие теги следующие:

{@link package.class#member label}
Вставляет встроенную ссылку с видимым текстом label это указывает на документацию для указанного пакета, class или имени элемента class, на который ссылаются. Этот тег допустим во всех комментариях документа: overview, package, module, class, function и attribute, включая текстовую часть любого тега (такой как @return, @param и @deprecated).
@see package.class#member label
Добавляет ссылку, с видимым текстом label, это указывает на документацию для указанного имени в API Сценария JavaFX, на который ссылаются. label является дополнительным. Если опущено, имя появляется вместо этого как видимый текст, соответственно сокращенный. Использовать -noqualifier глобально удалить имя пакета из этого видимого текста. Используйте label когда Вы хотите, чтобы видимый текст отличался от автоматически сгенерированного видимого текста.
@throws class-name description
@throws и @exception теги являются синонимами. Добавляет подзаголовок Бросков к сгенерированной документации, с class-name и description текст. class-name имя исключения, которое могло бы быть выдано методом. Этот тег допустим только в комментарии документа для функции. Многократный @throws теги могут использоваться в данном комментарии документа для тех же самых или различных исключений.

Авторское право © 2008, 2010, Oracle и/или его филиалы.






Spec-Zone.ru - all specs in one place