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

Documentation generator

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

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

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

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

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

Рекомендации

  1. ^ Брух, Марсель; Мезини, Мира; Монперрус, Мартин (2010). «Директивы создания подклассов для улучшения повторного использования фреймворка». 2010 7-я рабочая конференция IEEE по репозиториям программного обеспечения для майнинга (MSR 2010). С. 141–150. Дои:10.1109 / MSR.2010.5463347. ISBN 978-1-4244-6802-7.
  2. ^ Чжан, Сай; Чжан, Ченг; Эрнст, Майкл (2011). «Автоматизированный вывод документации для объяснения неудачных тестов» (PDF). 2011 26-я Международная конференция IEEE / ACM по автоматизированной разработке программного обеспечения (ASE 2011). С. 63–72. Дои:10.1109 / ASE.2011.6100145. ISBN 978-1-4577-1639-3.
  3. ^ Куры, Стефан; Монперрус, Мартин; Мезини, Мира (2012). «Полуавтоматическое извлечение часто задаваемых вопросов для повышения доступности знаний о разработке программного обеспечения». 2012 34-я Международная конференция по программной инженерии (ICSE). С. 793–803. arXiv:1203.5188. Дои:10.1109 / ICSE.2012.6227139. ISBN 978-1-4673-1067-3.

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