lab_tp_7_2013 (Методичка, задание и документация на ЛР №7)
Описание файла
Файл "lab_tp_7_2013" внутри архива находится в папке "Методичка, задание и документация на ЛР №7". Документ из архива "Методичка, задание и документация на ЛР №7", который расположен в категории "". Всё это находится в предмете "технологии разработки программного обеспечения (по)" из 10 семестр (2 семестр магистратуры), которые можно найти в файловом архиве МГТУ им. Н.Э.Баумана. Не смотря на прямую связь этого архива с МГТУ им. Н.Э.Баумана, его также можно найти и в других разделах. Архив можно найти в разделе "лабораторные работы", в предмете "технологии разработки по" в общих файлах.
Онлайн просмотр документа "lab_tp_7_2013"
Текст из документа "lab_tp_7_2013"
Технологии проектирования, 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 часа. Работа проводится в компьютерном зале.
Задание по управлению версиями:
-
Если система контоля версий Git не установлена, то установить ее (параметры оставить по умолчанию).
-
Запустить Git GUI (или консоль). Создать новый репозиторий. Добавить в папку репозитория файлы. Зафиксировать состояние репозитория (выполнить commit).
-
Внести изменения в файлы. Зафиксировать новое состояние репозитория.
-
Создать новую ветку 1. Внести в нее изменения и зафиксировать их.
-
Переключиться на ветку мастера. Внести в нее изменения и зафиксировать их.
-
Продемонстрировать слияние веток.
-
Просмотреть дерево изменений веток (историю).
-
Продемонстрировать откат изменений в ветке 1.
Задание по документированию:
-
Если система документирования Doxygen не установлена, то установить ее.
-
Создать новый прокт в Visual Studio (или использовать созданный ранее).
-
Выполнить комментирование кода по правилам Doxygen и сохранить проект.
-
Запустить Doxygen и выполнить настройку проекта.
-
Провести документирование и просмотреть полученный результат.
-
Продемонстрировать:
-
краткое и подробное описание класса,
-
краткое и подробное описание функции класса,
-
описание входных и выходных параметров функции,
-
описание переменной клсса,
-
описание проекта,
-
описание файла и добавление ссылки на файл в описание проекта.
Отчет:
После выполнения работы составляется отчет, который содержит:
-
титульный лист,
-
описание исходных требований,
-
выполняемые команды и скриншоты результатов для Git,
-
комментарии исходного кода и полученный результат для Doxygen.
