Цель работы

Изучить основные принципы работы генераторов документации и получить базовые навыки практического применения системы doc-o-matic.

Краткое введение

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

Применение генератора документации в проекте позволяет решить сразу несколько важных задач:

• экономия времени на создании документации (документация на API получается в качестве побочного результата разработки);
• в исходном коде будут задокументированы основные элементы - классы, свойства, методы;
• документация на API всегда может поддерживаться в актуальном состоянии (в этом случае достаточно включить вызов генератора документации в скрипт автоматической сборки проекта).

Программы

Лабораторная работа выполняется с помощью doc-o-matic
doc-o-matic
doxygen
Javadoc

Литература

•  Генератор документации
•  Сайт системы Doc-o-matic
•  Сайт Doxygen
•  Документирование javadoc