Генератор документации
 | Эта статья нуждается в дополнительных цитатах для проверки . ( декабрь 2009 г. ) |
Генератор документации — это инструмент программирования , который генерирует документацию по программному обеспечению , предназначенную для программистов ( документация API ) или конечных пользователей ( руководство конечного пользователя ) или и тех, и других, из набора файлов исходного кода , а в некоторых случаях и двоичных файлов . Некоторые генераторы, такие как Javadoc , могут использовать специальные комментарии для управления генерацией. Doxygen — пример генератора, который может использовать все эти методы.
Типы генерации [ править ]
Генерацию документов можно разделить на несколько типов:
- Пакетная генерация (общий метод)
- Соответствие текстовых блоков (документы, созданные на основе заранее определенных текстовых блоков)
- Формы (формы для сайтов)
- Синтез документации:
- Документацию можно вывести из кода
- Документацию можно получить по следам выполнения. [1]
Некоторые интегрированные среды разработки предоставляют интерактивный доступ к документации, метаданным кода и т. д.
См. также [ править ]
- Сравнение генераторов документации
- Процессор шаблонов
- Статический анализ кода
- Грамотное программирование
- Интегрированная среда разработки
Ссылки [ править ]
- ^ Чжан, Сай; Чжан, Ченг; Эрнст, Майкл (2011). «Автоматизированный вывод документации для объяснения неудачных тестов» (PDF) . 2011 26-я Международная конференция IEEE/ACM по автоматизированной разработке программного обеспечения (ASE 2011) . стр. 63–72. дои : 10.1109/ASE.2011.6100145 . ISBN 978-1-4577-1639-3 . S2CID 14846118 .
 | Эта статья, относящаяся к типу программного обеспечения, является незавершенной . Вы можете помочь Википедии, расширив ее . |