Средства составления проектной документации

Средства составления проектной документации

Учебно-методические материалы «Средства составления проектной документации» представляют собой методические указания к лабораторной работе по дисциплинам «Технологии разработки программного обеспечения» (по направлению магистерской подготовки) и «Технологии проектирования» (по направлению инженерной подготовки).

Цель работы:

Изучить базовые возможности и получить навыки создания документации на основе исходного кода программ с применением CASE средств.

В материалах рассмотрены принципы составления проектной документации на основе исходного кода программ. Приведены инструкции по работе и команды документирования исходных кодов для автоматического составления документации в среде Doxygen. Рассмотрены примеры использования указанных средств. В заключительной части методических указаний приведены контрольные вопросы, список рекомендуемой литературы и пример задания.

Ознакомившись с методическими указаниями и разобрав приведенные в нем примеры, студент может получить у преподавателя свой вариант задания и приступить к его выполнению.

Оглавление

Цель работы:................................................................................................................................................................................................... 1

Теория. Использование Doxygen для документирования кода............................................................................................................. 2

Использование Doxygen............................................................................................................................................................................... 2

Комментирование в стиле Doxygen.......................................................................................................................................................... 2

Практика – пример создания документации............................................................................................................................................... 5

Создание классов программного проекта в MS Visual Studio........................................................................................................... 5

Добавление в проект комментариев специального формата............................................................................................................ 7

Использование средств автоматического документирования........................................................................................................ 10

Примеры результатов документирования............................................................................................................................................ 12

Изменение документации.......................................................................................................................................................................... 15

Задание по документированию.................................................................................................................................................................... 16

Отчет................................................................................................................................................................................................................ 16

Контрольные вопросы................................................................................................................................................................................ 16

Источники...................................................................................................................................................................................................... 16

 

 

Теория. Использование Doxygen для документирования кода

Doxygen – это кроссплатформенная система документирования кода с поддержкой языков C++, C, Java, Objective-C, PHP, C# (список можно уточнить на сайте проекта).

Для создания документации достаточно просто писать комментарии в коде, придерживаясь нескольких простых правил.

Doxygen умеет анализировать исходный код проекта и создавать удобную документацию в формате HTML, Latex, RTF, XML, man, CHM.

Использование Doxygen

Использовать Doxygen просто – для этого надо просто запустить программу, указав ей путь к файлу с настройками. Файл с настройками представляет собой текстовой файл, который можно редактировать как в текстовом редакторе, так и с помощью специальных программ, например Doxygate.

В настройках описывается внешний вид документации, какие сущности и отношения между ними следует включать в нее, имя проекта, путь к анализируемым файлам и так далее.

Примеры результатов документирования

Страница проекта:

Страница Описаний (модулей):

Страница классов:

Класс Персоны (фрагмент):

Описание файла:

Для просмотра документов в формате RTF открыть файл RTF из каталога выходной документации.

Изменение документации

Если необходимо изменить документацию, то следует:

1) Открыть файлы с исходным кодом проекта,

2) Изменить в них комментарии,

3) Сохранить файлы проекта,

4) Заново запустить программу генерации документации.

5) Просмотреть полученный результат (обновить окно браузера).

 

Задание по документированию

1 Если система документирования Doxygen не установлена, то установить ее.

2 Создать новый прокт в Visual Studio.

3 Добавить в проект класс по своему варианту (с методами и свойствами).

4 Выполнить комментирование кода по правилам Doxygen и сохранить проект.

5 Запустить Doxygen и выполнить настройку проекта.

6 Провести документирование и просмотреть полученный результат (html и RTF).

7 Продемонстрировать:

ñ краткое и подробное описание класса,

ñ краткое и подробное описание функций класса,

ñ описание входных и выходных параметров функций,

ñ описание переменных класса,

ñ описание проекта,

ñ описание файла (h и cpp) и добавление ссылки на файл в описание проекта.

ñ описание производного класса.

Отчет

После выполнения работы составляется отчет, который содержит:

l титульный лист,

l описание исходных требований,

l комментарии исходного кода и полученный результат для Doxygen.

 

Контрольные вопросы

1. Возможности и назначение Doxygen?

2. Правила комментирования кода.

3. Настройки Doxygen.

Источники

· Система документирования исходных кодов Doxygen:

· Дистрибутив выдается преподавателем или скачивается из интернета.

· Основной материал - Краткое руководство по правилам комментирования http://www.devexp.ru/2010/02/ispolzovanie-doxygen-dlya-dokumentirovaniya-koda/

· Основной материал - Краткое руководство по использованию генератора документации http://microsin.ru/content/view/1218/1/

· Дополнительно - Подробное руководство по комментированию http://doxygenorg.ru/old/4

 

Средства составления проектной документации

Учебно-методические материалы «Средства составления проектной документации» представляют собой методические указания к лабораторной работе по дисциплинам «Технологии разработки программного обеспечения» (по направлению магистерской подготовки) и «Технологии проектирования» (по направлению инженерной подготовки).

Цель работы:

Изучить базовые возможности и получить навыки создания документации на основе исходного кода программ с применением CASE средств.

В материалах рассмотрены принципы составления проектной документации на основе исходного кода программ. Приведены инструкции по работе и команды документирования исходных кодов для автоматического составления документации в среде Doxygen. Рассмотрены примеры использования указанных средств. В заключительной части методических указаний приведены контрольные вопросы, список рекомендуемой литературы и пример задания.

Ознакомившись с методическими указаниями и разобрав приведенные в нем примеры, студент может получить у преподавателя свой вариант задания и приступить к его выполнению.

Оглавление

Цель работы:................................................................................................................................................................................................... 1

Теория. Использование Doxygen для документирования кода............................................................................................................. 2

Использование Doxygen............................................................................................................................................................................... 2

Комментирование в стиле Doxygen.......................................................................................................................................................... 2

Практика – пример создания документации............................................................................................................................................... 5

Создание классов программного проекта в MS Visual Studio........................................................................................................... 5

Добавление в проект комментариев специального формата............................................................................................................ 7

Использование средств автоматического документирования........................................................................................................ 10

Примеры результатов документирования............................................................................................................................................ 12

Изменение документации.......................................................................................................................................................................... 15

Задание по документированию.................................................................................................................................................................... 16

Отчет................................................................................................................................................................................................................ 16

Контрольные вопросы................................................................................................................................................................................ 16

Источники...................................................................................................................................................................................................... 16