НТП_МУ_ЛР. Томский государственный университет систем управления и радиоэлектроники кафедра компьютерных систем в управлении
 Скачать 1.31 Mb.
|
|
5.2 Список использованных источников 1. Калентьев А. А. Новые технологии в программировании : учеб. пособие / А. А. Калентьев, Д. В. Гарайс, А. Е. Горяинов. — Томск : Эль Контент, 2014. — 176 с. 2. Фаулер М. Рефакторинг. Улучшение существующего кода [Текст] / М. Фаулер. — М. : Символ, 2008. — 432 с. 3. Макконнелл С. Совершенный код. Мастер-класс / С. Макконнелл. — М. : Русская редакция, 2013. — 896 с. 74 6 Лабораторная работа № 6. Проектная документация Лабораторная работа направлена на обучение разработки проектной документации на созданный программный продукт. Имеющиеся типы про- ектной документации, которые необходимо включить в конечный отчёт, более подробно описаны в [1]. Отчёт необходимо оформить согласно Об- разовательному стандарту ТУСУРа 01-2013 [2]. Оформление отчёта, со- гласно стандарту, является обязательным этапом подготовки технического специалиста, т.к. очень часто рабочая документация на предприятии или фирме регламентируется либо внутренними документами, либо ГОСТами. Оформление отчёта можно выполнять в доступном текстовом процессоре (Microsoft Word, OpenOffice, LaTeX, Words и пр.). 6.1 Задание на лабораторную работу Ниже представлены основные пункты отчёта, которые необходимо включить в конечный документ: 1. Титульный лист. 2. Содержание. При составлении содержания ознакомьтесь с инст- рументами автоматической генерации содержания по имеющемуся доку- менту (с автоматической вставкой названий глав и номеров страниц). Изу- чение этой возможности текстового процессора поможет в дальнейшем сэ- кономить большое количество времени при добавлении/удалении глав из отчёта. 3. Составьте ТЗ на разработанную программу согласно информации из главы 2 учебного пособия [1]. 4. Введение, в котором необходимо описать назначение программ- ной документации, разрабатываемой в лабораторной работе. 75 5. Основная часть, в которой приводится описание программной сис- темы: a. Составьте UML диаграмму вариантов использования для разра- ботанной программы. Подробнее о том, что такое диаграммы ва- риантов использования и как их составлять, можно прочитать в главе 7 учебного пособия [1]. b. Составьте UML диаграмму классов. Подробнее о том, что такое диаграммы классов и как их составлять, можно прочитать в гла- ве 7 учебного пособия [1]. c. Для классов, образующих связь типа «общее-частное» (наследо- вание, реализация), приведите описание. В описание включите имеющиеся поля, свойства и методы класса, их типы и входные параметры в случае методов класса. Пример оформления описа- ния класса Person и Student из главы 7 учебного пособия [1] при- ведён в табл. 6.1 и табл. 6.2. Таблица 6.1 — Описание класса Person Название Тип Описание Описание класса Класс Person — сущность для описания абстрактного человека в программе Свойства + DateOfBirth Data Дата рождения человека + Name string Имя человека + Surname string Фамилия человека Методы + DoSomeWork() void Виртуальный метод, описывающий неко- торую работу, совершаемую человеком. Перегружается в производных классах 76 Название Тип Описание + GetAge() int Метод для расчёта возраста человека. Возвращает возраст человека # Person (Person, Data) Конструктор для создания нового чело- века с помощью фамилии и имени дру- гого человека и даты рождения. Person — человек, на основе имени и фамилии которого, планируется создать новый экземпляр класса. Data — дата рождения человека # Person (string, string, Date) Конструктор для создания нового чело- века с помощью фамилии, имени и даты рождения. String — имя человека. String — фамилия человека. Data — дата рождения человека + TalkAboutOthers (Per- son) string Метод, позволяющий одному человеку рассказать информацию о другом человеке Таблица 6.2 — Описание класса Student Название Тип Описание Описание класса Класс Student — сущность для описания студента университета в программе Методы + DoSomeWork() void Перегруженный метод базового класса, в котором описывается процесс обучения студентом Окончание табл. 6.1 77 Название Тип Описание # Student (Person, Data) Конструктор для создания нового сту- дента с помощью фамилии и имени дру- гого человека и даты рождения. Вызыва- ет конструктор базового класса # Student (string, string, Date) Конструктор для создания нового сту- дента с помощью фамилии, имени и да- ты рождения. Вызывает конструктор ба- зового класса При описании свойств и методов класса допускается для краткости использовать принятые в UML обозначения модификаторов доступа. По- мимо этого, подобное описание в MSDN-подобном [3] формате можно сге- нерировать автоматически при наличии качественных XML-комментариев в коде. Использование подобных инструментов и подробный разбор XML- комментариев в пособии по лабораторному практикуму не предусмотрен, однако для общего развития и повышения профессиональных компетенций подробное изучение этого материала вполне оправдано. Приведите дерево ветвлений Git, полученное по окончанию работы с проектом. Пример дерева ветвления Git можно найти в данном пособии в главе 3 на рис. 3.21. Добавьте в отчёт главу, описывающую процесс тестирования вашей программы. В главе необходимо отразить два типа тестирования: функ- циональное и модульное. При описании функционального тестирования необходимо привести набор тестовых случаев, выполняемых пользователем с помощью GUI, и результат работы программы на эти тестовые случаи. Помимо позитивных тестовых случаев (ввод правильных данных, корректная работа) необхо- Окончание табл. 6.2 78 димо привести примеры негативных тестовых случаев (ввод некорректных данных, возможно, некорректная работа программы). При обнаружении некорректной работы программы необходимо включить результаты тести- рования в документ и описать, что было изменено в программе для недо- пущения подобных ошибок в дальнейшем. Если ошибка будет находиться не на уровне GUI, а на уровне работы класса — необходимо написать мо- дульный тест для покрытия подобного случая. При описании модульного тестирования — необходимо привести набор тестовых случаев, проверяющих работу классов. Помимо этого, не- обходимо привести структуру тестового проекта в Visual Studio. Это мож- но сделать скриншотом как на рис. 6.1. Рисунок 6.1 — Структура тестового проекта в Visual Studio 6. Заключение, глава, в которой необходимо сделать выводы по вы- полненной работе. 7. Список использованной литературы. Следует отметить, что на большинство источников литературы должны быть ссылки в тексте отчёта. Правильное оформление источников приведено в [2]. 8. При необходимости некоторые части можно вынести в приложе- ния. Описание оформления приложений также приведено в [2]. 79 6.2 Список использованных источников 1. Калентьев А. А. Новые технологии в программировании : учеб. пособие / А. А. Калентьев, Д. В. Гарайс, А. Е. Горяинов. — Томск : Эль Контент, 2014. — 176 с. 2. Работы студенческие по направлениям подготовки и специально- стям технического профиля. Общие требования и правила оформления. ОС ТУСУР 01-2013 53 с. 3. Microsoft Software Developer Network [Электронный ресурс]. — URL: http://msdn.microsoft.com/ru-ru/default.aspx (дата обращения 18.12.2014). |