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

Программный инструмент

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

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

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

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

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

Смотрите также

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

Ссылки

1. Чжан, Сай; Чжан, Ченг; Эрнст, Майкл (2011). «Автоматизированный вывод документации для объяснения неудачных тестов» (PDF) . 2011 26-я Международная конференция IEEE/ACM по автоматизированной программной инженерии (ASE 2011) . стр. 63–72. doi :10.1109/ASE.2011.6100145. ISBN 978-1-4577-1639-3. S2CID  14846118.