ЗаголовокДок
| Разработчик(и) | Apple Инк. |
|---|---|
| Первоначальный выпуск | 13 сентября 2000 г. |
| Стабильная версия | 8,9
/ 8 июня 2009 г. |
| Написано в | Perl , C (помощники) |
| Операционная система | Mac OS X , UNIX , Linux |
| Тип | Генератор документации |
| Лицензия | Лицензия Apple на общедоступный исходный код 2.0 |
| Веб-сайт | разработчик |
HeaderDoc — это генератор документации, разработанный и поддерживаемый Apple Inc. Используя в качестве входных данных специально прокомментированные файлы исходного кода, HeaderDoc генерирует документацию для кода в формате HTML или XML . Синтаксис тегов комментариев HeaderDoc во многом аналогичен синтаксису HeaderDoc версии 8 и поддерживает теги Javadoc . HeaderDoc 8.7 и более поздних версий также обеспечивает частичную поддержку многих тегов Doxygen (@ только в форме и должен соответствовать правилам упорядочения тегов HeaderDoc). Проект Apple HeaderDoc — это бесплатное , программное обеспечение с открытым исходным кодом распространяемое по лицензии Apple Public Source License .
Поддерживаемые языки обычного текста
[ редактировать ]- AppleScript
- Баш
- Борн Шелл
- С Оболочка
- С
- С++
- Корн Шелл
- Ява
- JavaScript
- Маха Определения МИГ [1]
- Цель-C
- Паскаль
- Перл
- PHP
- Питон
- Руби
- Ткл
Набор инструментов HeaderDoc состоит из основной утилиты headerdoc2html и Collectheaderdoc. Инструмент headerdoc2html создает каталог файлов HTML (или, при необходимости, XML ) из указанных исходных файлов с комментариями. После этого можно запустить утилиту сборхедердок для создания файла оглавления документации. Наконец, утилитуsolveLinks можно использовать для разрешения перекрестных ссылок между несколькими коллекциями документации.
Среда разработки Apple Xcode содержит функции, предназначенные для облегчения процесса создания документации с использованием синтаксиса и инструментов HeaderDoc.
Дополнительные возможности
[ редактировать ]HeaderDoc имеет следующие основные функции:
- Предварительная обработка C, позволяющая выбранным пользователем макросам #define изменять содержимое и позволяющая пользователю передавать флаги командной строки, чтобы игнорировать части ввода.
- Раскраска синтаксиса с помощью пользовательских стилей.
- Целевые страницы на основе шаблонов для индексов.
- Кроссплатформенность (написана в основном на Perl).
Пакет HeaderDoc также включает в себя несколько инструментов, которые можно использовать независимо:
- MPGL — набор инструментов, предназначенных для упрощения создания страниц руководства UNIX с использованием упрощенного синтаксиса XML, состоящего из подмножества XHTML, а также тегов разделов, тегов параметров и т. д. HeaderDoc также предоставляет инструмент, который помогает создавать страницы руководства из комментариев заголовков для функций. через режим вывода XML HeaderDoc.
- solveLinks — инструмент, который позволяет быстро перелинковывать веб-сайты при перемещении контента на другой адрес с помощью встроенных привязок и запросов ссылок.
- filtermacros.pl — инструмент, который можно использовать для фильтрации разделов заголовков на основе макросов препроцессора C. В настоящее время это доступно только после загрузки исходного архива. Начиная с HeaderDoc 8.9, эта функция встроена в сам инструмент headerdoc2html.
См. также
[ редактировать ]
Внешние ссылки
[ редактировать ]- Устаревшая документация: Руководство пользователя HeaderDoc
- http://opensource.apple.com Последняя версия] (сейчас 8.9.28)
- Список рассылки HeaderDoc (обычно используется для получения помощи, исправлений и т. д.)
 | Эта инструментам программирования, статья, посвященная является незавершенной . Вы можете помочь Википедии, расширив ее . |