Поддерживаемые языки

HeaderDoc 8 поддерживает еще много языков, чем HeaderDoc 7. Эта таблица показывает различные языки и уровень поддержки.

Основные функции

HeaderDoc 8 имеет много новых функций.

• Группировки функции/типа данных

• Окраска синтаксиса объявления

• Новый tagless синтаксис

  /*! This is a comment about what comes next */

• Поддержка тегов HeaderDoc встраивается в объявления

• Поддержка //! стиль разметки для встроенных объявлений HeaderDoc

• Автоматическое соединение типов данных в объявлениях

• Улучшенная поддержка C++ (пространство имен/шаблон/доступ)

• gatherheaderdoc инструмент является теперь базируемым шаблоном

• Поддержка PHP (и набор других языков) теперь включенный без исправления

• Поддержка соединения с другими методами и типами данных в том же файле

• Стриппер комментария

• Поддержка исключений

• Если маркированные параметры не соответствуют объявление, теперь предупреждает

• Дополнительное предупреждение, если не тегируются параметры

• Улучшенные предупреждения для другого недопустимого содержания

• Выходной путь страницы справочника (через XML)

• DTD для выходной проверки

• Перевод HTML к использованию XHTML xmllint при использовании вывода XML

• Вложенная обработка класса

• Настраиваемый формат даты

• C поддержка псевдокласса (typedef struct)

• Лучше вложенная поддержка класса

• Конструкторы/деструкторы C++ теперь сортировали сначала в списке методов класса.

• Тег @ignore — позволяет Вам удалять соответствие маркеров из объявлений

• Флаг «Unsorted»

• Сводные функциональные и списки методов (мини-TOC)

• Автоматизированное обнаружение пронумерованных списков

• Автоматическая обработка макросов доступности

• Улучшенное полное появление

• Включает комплект регрессионного теста

Новые теги

Этот раздел пытается перечислить все новые теги, добавленные в HeaderDoc 8 (некоторые из которых были фактически доступны, но не документированы в HeaderDoc 7).

@classdesign

Текстовый блок, описывающий общий замысел класса

@coclass

Строка, описывающая класс, с которым этот класс был разработан для работы

@dependency

Строка, описывающая класс, от которого этот класс зависит в большой степени

@exception

Строка, описывающая исключение, выданное функцией/методом/классом

@functiongroup

Тег для группировки функций и методов; это принимает приоритет @group тег относительно функций и методов.

@group

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

(Примечание: @functiongroup тег принимает приоритет @group тег для функций.)

@helper

Строка, говорящая, что классы помощника этот класс использование

@helps

Для классов помощника, строка, говорящая, какие классы этот класс были разработаны для помощи

@instancesize

Текстовый блок, содержащий размер экземпляра этого класса

@methodgroup

Посмотрите @functiongroup.

@ownership

Строка, описывающая, какой класс инстанцирует текущего класса (например, куски Набора I/O)

@performance

Текстовый блок для описания показателей производительности класса (например, “Этот класс не является подходящим для использования в высокоэффективных средах”),

@security

Текстовый блок для описания соображений безопасности при использовании этого класса

@superclass

Добавляет информация суперкласса к псевдоклассу C; также может использоваться, чтобы заставить элементы суперкласса быть объединенными в подкласс

@throws

Посмотрите @exception.

Дополнительные примечания

Этот раздел перечисляет известные проблемы в HeaderDoc 8. Мы надеемся улучшиться в этих областях в будущих версиях. Если Вы считаете проблемы не перечисленными здесь, ошибки файла.

• HeaderDoc 8 несколько медленнее, чем предыдущие версии. Это вызвано тем, что весь синтаксический анализатор был переписан с нуля и теперь делает основанный на маркере синтаксический анализ входного файла.

  В то время как этот подход должен значительно улучшить правильность вывода (colorizer ошибки несмотря на это), это выполняет намного больше работы, чем прежде, и таким образом занимает больше времени.

• Схема цвета по умолчанию, сгенерированная HeaderDoc, соответствует окраску XCode. Существует много файлов, предоставленных как альтернативные цветовые схемы, в пределах от приятного к совершенно отвратительному и мигающему (используются в основном для тестирования). Выгрузите Ваш headerDoc2HTML.config файл, как желаемый.

• Несмотря на то, что минимальное gatherheaderdoc шаблон встроен в сам инструмент, шаблон по умолчанию, используемый gatherheaderdoc фактический файл, прибывающий предварительно установленный как Xcode.app/Contents/Developer/usr/share/headerdoc/conf/com.apple.headerdoc.exampletocteplate.html в комплекте приложений XCode (или /usr/share/headerdoc/conf/com.apple.headerdoc.exampletocteplate.html если Вы создали HeaderDoc сами). Формат для этого шаблона описан в Усовершенствованной Конфигурации HeaderDoc и Функциях. Также посмотрите Пример gatherheaderdoc Шаблон для примера шаблонного формата.

Поздно повреждающиеся ошибки

В этом разделе описываются поздно повреждающиеся ошибки в HeaderDoc 8.9.

Нет никаких известных опечаток еще для HeaderDoc 8.9.

Чтобы усовершенствовать с последними опечатками и исправлениями ошибок, присоединитесь к headerdoc-dev списку рассылки.