lab_tp_7_2013 (1035111)

Просмтор этого файла доступен только зарегистрированным пользователям. Но у нас супер быстрая регистрация: достаточно только электронной почты!

Текст из файла

Технологии проектирования, 2013г.

Лабораторная работа №7

«Управление версиями

и построение документации на основе исходного кода программ»

по курсу Технологии проектирования

Цель работы:

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

Исходные данные для выполнения работы:

• Система управления версиями Git:

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

• Основной материал - Краткое руководство по использованию Windows-клиента Git-Gui http://tutorials.assembla.com/git-guide-for-windows-users/tour.ru.html

• Дополнительно - Руководство по использованию ее аналога Git Extensions http://www.rsdn.ru/article/tools/Git.xml

• Дополнительно - Краткое руководство по командам Git http://www.calculate-linux.ru/main/ru/git

• Дополнительно - Подробное руководство по командам Git http://marklodato.github.io/visual-git-guide/index-ru.html

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

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

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

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

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

Возможно использование других систем по желанию студента. В этом случае дистрибутив и учебные материалы студент находит самостоятельно.

Порядок и время проведения работы:

Время проведения работы 2 часа. Работа проводится в компьютерном зале.

Задание по управлению версиями:

1. Если система контоля версий Git не установлена, то установить ее (параметры оставить по умолчанию).

2. Запустить Git GUI (или консоль). Создать новый репозиторий. Добавить в папку репозитория файлы. Зафиксировать состояние репозитория (выполнить commit).

3. Внести изменения в файлы. Зафиксировать новое состояние репозитория.

4. Создать новую ветку 1. Внести в нее изменения и зафиксировать их.

5. Переключиться на ветку мастера. Внести в нее изменения и зафиксировать их.

6. Продемонстрировать слияние веток.

7. Просмотреть дерево изменений веток (историю).

8. Продемонстрировать откат изменений в ветке 1.

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

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

2. Создать новый прокт в Visual Studio (или использовать созданный ранее).

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

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

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

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

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

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

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

• описание переменной клсса,

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

• описание файла и добавление ссылки на файл в описание проекта.

Отчет:

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

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

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

• выполняемые команды и скриншоты результатов для Git,

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

Характеристики

Тип файла документ

Документы такого типа открываются такими программами, как Microsoft Office Word на компьютерах Windows, Apple Pages на компьютерах Mac, Open Office - бесплатная альтернатива на различных платформах, в том числе Linux. Наиболее простым и современным решением будут Google документы, так как открываются онлайн без скачивания прямо в браузере на любой платформе. Существуют российские качественные аналоги, например от Яндекса.

Будьте внимательны на мобильных устройствах, так как там используются упрощённый функционал даже в официальном приложении от Microsoft, поэтому для просмотра скачивайте PDF-версию. А если нужно редактировать файл, то используйте оригинальный файл.

Файлы такого типа обычно разбиты на страницы, а текст может быть форматированным (жирный, курсив, выбор шрифта, таблицы и т.п.), а также в него можно добавлять изображения. Формат идеально подходит для рефератов, докладов и РПЗ курсовых проектов, которые необходимо распечатать. Кстати перед печатью также сохраняйте файл в PDF, так как принтер может начудить со шрифтами.

Список файлов лабораторной работы