1.2 О FPDoc

На верх  Назад  Вперёд

FPDoc - это инструмент, который объединяет файл модуля Pascal и файл описания в формате XML и создает справочную документацию для модуля.

Справочная документация содержит описание всех идентификаторов, найденных в интерфейсной части модуля. Документация связана перекрёстными ссылками, что упрощает навигацию. Также можно ссылаться на другие пакеты документации, написанные с помощью FPDoc, что позволяет поддерживать большие комплекты документации для крупных проектов.

В отличие от некоторых других методов документирования, FPDoc не требует наличия форматированных комментариев в исходном коде. Он берёт исходный файл и файл документации (в формате XML) и объединяет эти два источника вместе. Таким образом код не становится запутанным, с большими комментариями, что затрудняет его чтение и понимание.

FPDoc ориентирован на пакет, что означает, что он рассматривает модули как части пакета. Документация для всех модулей в пакете может быть сгенерирована за один проход.

На момент написания документа документация может быть сгенерирована в следующих форматах:

HTML

Обычный HTML. Javascript используется для отображения небольшого окна с свойствами класса или методами класса. Но документация HTML будет работать и без JavaScript.  Для разметки используются таблицы стилей (css файл), поэтому вывод можно настроить.

XHTML

Как HTML, но используя более строгий синтаксис.

LaTeX

LaTeX, которые можно использовать с файлом fpc.sty, который поставляется с документацией Free Pascal. Из этого вывода могут быть сгенерированы документы PDF и с использованием файлов latex2rtf, RTF или Winhelp. Текстовые файлы также могут быть сгенерированы.

Text

Простые текстовые файлы ascii. Перекрестных ссылок не существует. Кроме того, он похож на выход LaTeX по структуре.

Man

Страницы man (manual) Unix. Каждый идентификатор функции/процедуры/метода является страницей man. Константы находятся на отдельной странице, как и типы, переменные и ресурсы.

CHM

HTML-файлы, сжатые в файл .chm с использованием сжатия lzx.

RTF

Линейные файлы RTF.

Обратите внимание, что программные файлы pascal (файлы program) не могут быть проанализированы с помощью fpdoc, поэтому невозможно создать документацию для программы. Поддерживаются только модули.