8.3. fpdoc – документирование модулей Pascal

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

Fpdoc – это программа, которая генерирует полную документацию с перекрёстными ссылками для модуля. Она генерирует документацию для каждого идентификатора, найденного в модуле в разделе interface. Документация может быть нескольких форматов, таких как HTML, RTF, текстовый документ, гипертекстовая страница и LaTeX. В отличие от других инструментов документирования, документация может быть в отдельном файле (в XML формате), поэтому набор документов не будет хаотичным. Совместно с программой makeskel создаётся пустой XML-файл, добавляются элементы для новых идентификаторов.

Программы Fpdoc и makeskel описаны в документе «Документирование кода Free Pascal».