Генератор документации

A Генератор документации - это инструмент программирования, который генерирует документацию по программному обеспечению, предназначенную для программистов (документация по API ) или конечным пользователям (руководство для конечных пользователей ), или и то и другое, из набора файлов исходного кода, а в некоторых случаях двоичные файлы. Некоторые генераторы, такие как Doxygen или Javadoc, используют специальные комментарии для управления генерацией.

Типы генерации

Генерацию документов можно разделить на несколько типов:

• Пакетная генерация (общий метод)
• Соответствие текстовых блоков (документы, созданные на основе заранее определенных текстовые блоки)
• Формы (формы для веб-сайтов)
• Синтез документации:
  • Документация может быть выведена из кода
  • Документация может быть выведена из следов выполнения
  • Документация может быть получена из списков рассылки

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

Ссылки

См. также

• Сравнение генераторов документации
• Шаблонный процессор
• Статический анализ кода
• Грамотное программирование
• Интегрированная среда разработки