7 Методические рекомендации по оформлению пояснительной записки курсового проекта

Структурными элементами пояснительной записки являются:

• титульный лист (рисунок 1);

• задание (выдается кафедрой);

• содержание (включает наименование разделов и подразделов с указанием страниц, с которых они начинаются);

• введение;

• основная часть;

• заключение;

• список использованных источников;

• приложения (при наличии).

Р

Министерство образования Республики Беларусь

Министерство образования и науки Российской Федерации

Государственное учреждение высшего профессионального образования

БЕЛОРУССКО–РОССИЙСКИЙ УНИВЕРСИТЕТ

Кафедра «Автоматизированные системы управления»

Разработка программного модуля

Курсовая работа

по дисциплине ВТиП

<Шифр>

Допущен: «_»__200_г _____ Защитил: «_»__200_г _____ Оценка__________ Комиссия: _________ _________

Выполнил: студент гр. ТМЗ-21 _______ Иванов И.И. Руководитель:_________ _______ _______________

2004

исунок 18 – Пример оформления титульного листа

<Шифр> имеет следующую структуру:

051.<шифр специальности>.<№ зачетки>.<№ по списку>.81-01

где 051 – код вуза;

<шифр специальности> - определен для каждой специализации, например для специальности «Технология машиностроения» шифр имеет вид 1-36 01 01, «Сварочное производство» - 1-36 01 06, «Технология эксплуатации автомобилей» - 1-37 01 06 и т.д.;

<№ зачетки> - шесть цифр номера зачетной книжки;

<№ по списку> - номер студента по экзаменационной ведомости.

П ояснительная записка выполняется на листах формата А4 с текстовым штампом (один большой текстовый штамп (рисунок 19) под содержание, остальные – малые (рисунок 20)).

Рисунок 19 – Большой текстовый штамп

Р исунок 20 – Малый текстовый штамп

Вся пояснительная записка оформляется единым шрифтом (Times New Roman, 14, междустрочный интервал – полуторный, отступ –1,25 см).

Разделы и подразделы ведутся с абзаца и отделяются вертикальными отступами (12 пт). Разделы и подразделы нумеруются, но не нумеруются (и, как правило, центрируются) содержание, введение, заключение и список использованных источников.

Нумерация страниц ведется в штампе. Титульный лист учитывается как первый, но номер страницы на нем не проставляется. Задание в нумерации страниц не учитывается.

Разделы пояснительной записки

Расчетно-пояснительная записка состоит из следующих разделов.

Введение

1. Постановка задачи

1.1 Математическая модель задачи

1.2 Входные данные

1.3 Выходные данные

1.4 Обработка ошибок

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

   1. Структурная диаграмма программного модуля

   2. Разработка схемы программного модуля и ее описание

   3. Разработка пользовательского интерфейса

3. Реализация программного модуля

   1. Код программы

   2. Описание используемых операторов и функций

4. Тестирование программного модуля

Заключение

Список использованных источников

Приложения

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

В разделе «Математическая модель задачи» строится математическая или логическая модель исследуемого явления (логическая модель — для задач невычислительного характера). Математическая модель может быть в виде формул, таблиц, графиков, графов и др. Все математические зависимости должны быть подробно объяснены.

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

Пример.

Входные данные:

1. левая граница отрезка, содержащего корень уравнения;

2. погрешность вычисления.

Требования к входным данным:

- предусмотреть проверку на допустимость исходных данных и повторение ввода при ошибочных данных;

- ввод исходных данных осуществлять в соответствующие ячейки листа Excel и поля ввода формы;

- ограничений на значения входных данных нет.

В разделе «Выходные данные» описываются выходные данные, указывается, в каком виде должны быть представлены — в числовом, графическом или текстовом, приводятся некоторые другие сведения.

Пример.

Выходные данные:

1. правая граница отрезка, содержащего корень уравнения;

2. корень уравнения;

3. значение функции в точке, являющейся корнем уравнения;

4. количество итераций при нахождении корня.

Результатом работы программы является также график функции.

Требования к выходным данным:

- все выходные данные выводятся на лист Excel и на форму;

- ко всем выходным данным должен быть запрещен доступ со стороны пользователя;

- график функции должен иметь название и подписи по двум осям.

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

Пример.

При выполнении программного модуля необходимо предусмотреть обработку следующих ошибок:

• неправильный ввод исходных данных;

• невозможность выделения отрезка, содержащего корень уравнения.

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

При разработке программного комплекса должна использоваться технология нисходящего структурного программирования. В соответствии с этой технологией программный комплекс разбивается на программные модули и разрабатываются алгоритмы для каждого модуля с использованием одного из методов записи алгоритма: словесная форма; язык проектирования программ; таблицы решения (используются для разработки программ логического типа, в которых требуется проверка многочисленных логических условий); блок-схемы (обеспечивают наглядное двумерное представление алгоритма). Разрабатывается схема взаимодействия программных модулей (схема потоков данных или структурная диаграмма).

В разделе «Структурная диаграмма программного модуля» приводится структурная диаграмма, которая отражает взаимосвязь модулей программного комплекса.

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

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

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

Пример.

Программа будет иметь структуру, показанную на рисунке 20.

Структурная диаграмма включает четыре уровня. Первый уровень — UserForm1 –пользовательская форма с текстовыми полями для ввода и вывода данных и двумя кнопками. Второй уровень состоит из процедур, которые вызываются теми или иными событиями, связанными с элементами UserForm1. Одна процедура второго уровня вызывает две функции третьего уровня. Функции третьего уровня вызывают функции четвертого уровня. Функции, которыми заканчиваются ветви структурной диаграммы, дальнейшей детализации не требуют.

Рисунок 20 - Структурная диаграмма программного модуля

Здесь UserForm_Initialize() – процедура начальной инициализации пользовательской формы.

CommandButton1_Click() – процедура, срабатывающая при нажатии кнопки «Найти корень», которая считывает исходные данные и выводит результат работы программы.

CommandButton2_Click()- процедура, срабатывающая при нажатии кнопки «Выход», используемая для завершения программы.

met_hord() – функция для уточнения корня методом хорд.

met_kas() – функция для уточнения корня методом касательных.

f()- функция для расчета значений искомой функции.

pf() - функция для расчета значений первой производной искомой функции.

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

Пример.

Введем следующие обозначения:

а - левая граница отрезка;

b - правая граница отрезка;

с - середина отрезка;

е - погрешность вычисления.

Р исунок 21– Схема алгоритма функции dihotomija

Описание блок-схемы к функции.

Блок 1 – нахождение середины отрезка.

Блок 2 – сравнение знаков функции в точках a и c. Если условие верно, выполняется блок 3, в противном случае – блок 4.

Блок 3 – перемещение левой границы отрезка в точку с.

Блок 4 – перемещение правой границы отрезка в точку с.

Блок 5 - условие продолжения цикла. В случае его выполнения возвращаемся к блоку 2.

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

В разделе «Разработка пользовательского интерфейса» должны быть представлены основные входные и выходные формы (виды экрана).

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

В разделе «Код программы» приводится полный текст программы с необходимыми комментариями.

В разделе «Описание используемых операторов и функций» описываются все использованные в программе операторы и функции.

В разделе «Тестирование программного модуля» приводятся результаты работы программы при обработке тестовых данных. Разработка программы сопровождается тестированием получаемых результатов и отладкой. Результаты, которые получаются при обработке тестовых исходных данных, сверяются с тестовыми результатами (которые могут быть рассмотрены в подразделе 2.1). При их сопоставлении определяется идентичность результатов или их отклонения и делается заключение о правильности работы созданного программного обеспечения.

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

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

Заключение должно содержать краткие выводы и оценку полученных результатов.

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

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

Приложение оформляют как продолжение документа на последующих его листах. В тексте документа на все приложения должны быть даны ссылки. Каждое приложение следует начинать с новой страницы с указанием наверху по середине страницы слова "Приложение" и его обозначение. Приложение должно иметь заголовок, который записывают симметрично относительно текста с прописной буквы отдельной строкой. Обозначают приложения заглавными буквами русского алфавита, начиная с А, за исключением букв Ё, 3, И, О, Ч, Ь, Ъ. После слова "Приложение" следует буква, обозначающая его последовательность.

Список литературы

1. Биллинг В.А. VBA и Office 2000. Офисное программирование. – М.:»Русская редакция», 1999.

2. Гарнаев А.Ю. Использование MS Excel и VBA в экономике и финансах. – СПб, БХВ –Санкт-Петербург, 2002.

3. Гарнаев А.Ю. Самоучитель VBA. – СПб, БХВ –Санкт-Петербург, 2002.

4. Васильев А. VBA в Office 2000: учебный курс. - СПб, Питер, 2002.

5. Кузьменко В.Г. VBA 2002. – М.: Издательство БИНОМ, 2002.

6. MS OfficeХР : Разработка приложений / Под ред Ф.А. Новикова. СПб.: БХВ-Петербург, 2003.