Описание языка программирования
Пункт «Описание языка программирования» по своей структуре соответствует программному документу «Описание языка» (ГОСТ 19.506-79) и должен содержать следующие подпункты:
¨ Общие сведения
¨ Элементы языка
¨ Способы структурирования программы
¨ Встроенные элементы
¨ Средства отладки
В подпункте «Общие сведения» должна быть указана общая характеристика языка, его отличительные особенности и области применения; а также могут содержаться другие сведения, например, исторические сведения о создании языка.
В подпункте «Элементы языка» приводится описание основных элементов языка, таких как:
¨ Алфавит
¨ Константы и переменные
¨ Типы данных
¨ Операции и правила составления выражений
¨ Операторы
¨
При описании каждого оператора указывается его синтаксис (правила написания) и семантика (смысл) оператора.
В подпункте «Способы структурирования программы» приводится описание общей структуры программы, а также способов описания и вызова процедур и функций, и передачи параметров в них.
В подпункте «Встроенные элементы»приводится перечень и краткая характеристика основных библиотечных модулей, а также описание использованных в разработанной программе библиотечных процедур и функций.
В подпункте «Средства отладки программы» описываются основные возможности, предоставленные отладчиком, такие как пошаговое выполнение программы, точки останова, контроль значений переменных и т.д.
В пункт «Описание языка» допускается вводить дополнительные подпункты.
Практическая часть
Раздел «Практическая часть» включает в себя следующие пункты:
¨ Постановка задачи.
¨ Описание схем.
¨ Текст программы.
¨ Описание программы.
¨ Руководство оператора.
¨ Программа и методика испытаний.
¨ Протокол испытаний.
Постановка задачи
Пункт «Постановка задачи» по структуре соответствует программному документу «Техническое задание» (ГОСТ 19.201-78) и должен включать в себя следующие подпункты:
¨ Основание для разработки
¨ Назначение разработки
¨ Требования к программе
¨ Требования к программной документации
¨ Стадии и сроки разработки
¨ Виды испытаний
В подпункте «Основание для разработки» указывается, что программа разрабатывается на основе задания преподавателя.
В подпункте «Назначение разработки» указывается, для решения какой задачи предназначена разрабатываемая программа.
Подпункт «Требования к программе»,в свою очередь, разделяется на следующие структурные единицы:
¨ Требования к функциональным характеристикам
¨ Требования к надежности
¨ Требования к условиям эксплуатации
¨ Требования к техническим средствам
¨ Требования к информационной и программной совместимости
¨ Требования к маркировке и упаковке
¨ Требования к транспортировке и хранению
«Требования к функциональным характеристикам» - это перечень действий, которые должна выполнять программа, и требования к характеристикам выполняемых действий (как в разделе «Требования к функциональным характеристикам» задания на курсовое проектирование), а так же требования к входным и выходным данным (как в разделе «Описание исходных данных» и «Требования к составу и форме выдачи результатов программы» задания на курсовое проектирование). Если входными или выходными данными являются файлы, то должен быть описан их формат (текстовый или двоичный; если текстовый, то каким образом информация разделяется на строки и т. д.). Должны быть приведены формы (образцы) выходных документов программы.
«Требования к надежности» будут подробно изучаться на 4 курсе, поэтому в курсовом проекте можно записать, что требования к надежности отсутствуют, так как при отказе программы она может быть выполнена повторно.
«Требования к условиям эксплуатации»– это описание параметров внешней среды (температура, влажность и т.д.), при которых будет эксплуатироваться программа, а также описание необходимых действий по обслуживанию программы в процессе эксплуатации.
«Требования к техническим средствам»– это описание параметров (тип процессора, объем памяти, наличие свободного места на винчестере) того компьютера, на котором будет работать программа.
«Требования к информационной и программной совместимости»подразумевают указание типа операционной системы, под управлением которой будет работать программа, а также указание того, какие программы должны использоваться для подготовки входных файлов для разрабатываемой программы, и какие программы могут использоваться для просмотра выходных файлов разрабатываемой программы.
«Требования к маркировке и упаковке»содержат информацию о том, на каком магнитном носителе будет поставляться программа, какая маркировка будет на этом носителе и как он будет упакован.
«Требования к транспортировке и хранению» содержат требования к условиям транспортировки и хранения магнитного носителя с программой.
В подпункте «Требования к программной документации » указываются, какие программные документы должны быть разработаны для программы. Это должны быть:
¨ Текст программы (ГОСТ 19.401-78)
¨ Описание программы (ГОСТ 19.402-78)
¨ Руководство оператора (ГОСТ 19.505-79)
¨ Программа и методика испытаний (ГОСТ 19.301-79)
¨ Описание языка (ГОСТ 19.507-79)
В подпункте «Стадии разработки»указываются сроки сдачи технического ирабочего проекта.
В подпункте «Виды испытаний»указывается, что приемо-сдаточные испытания проводятся преподавателем.
Описание схем
В данном пункте приводятся схемы программы и содержащихся в ней процедур и описания каждой схемы. Схемы выполняются по ГОСТ 19.701-79 «Схемы программ, данных и систем. Условные обозначения и правила выполнения». При описании схемы указывается, какие действия, в каком порядке выполняются, и приводятся ссылки на соответствующие блоки схем. При этом особое внимание следует обращать на объяснение сути выполняемых действий и назначения используемых переменных.
Текст программы
В данном пункте указывается, что текст программы представляет собой документ, выполненный машинным способом, и приводится ссылка на соответствующее приложение к пояснительной записке курсового проекта, которое должно содержать распечатку текста программы.
Описание программы
Пункт «Описание программы» по своей структуре соответствует программному документу «Описание программы» (ГОСТ 19.402-78) и должен содержать следующие подпункты:
¨ Общие сведения
¨ Назначение программы
¨ Описание логической структуры
¨ Используемые технические и программные средства
¨ Вызов и загрузка
¨ Входные и выходные данные
В подпункте «Общие сведения» приводится название программы, указывается, на каком языке она написана и под управлением какой операционной системы работает.
В подпункте «Назначение программы» указывается, для решения каких задач она предназначена.
В подпункте «Описание логической структуры»указывается, из каких структурных единиц (процедур и функций) состоит программа. Приводится описание работы программы, примерно так же, как в пункте «Описание схем», но для каждой процедуры указывается ее назначение, описываются входные и выходные параметры, и указывается, какие процедуры и функции вызывает данная процедура. В данном пункте приводится также информация о том, в каких файлах находится исходный текст программы, в каком файле или каких файлах находится исполняемый модуль программы, сколько места он занимает, каких файлов требует для нормальной работы и т.д.
В подпункте «Используемые технические и программные средства» приводится описание минимальной конфигурации технических средств, необходимых для работы программы (тип процессора, объем памяти, требуемые внешние устройства и т.д.).
В подпункте «Вызов и загрузка»указывается, как запустить программу.
В подпункте «Входные и выходные данные» приводится описание структуры и формы представления входных и выходных данных (примерно так же, как в соответствующих разделах задания на курсовое проектирование).
Руководство оператора
Данный пункт по структуре соответствует программному документу «Руководство оператора» (ГОСТ 19.505-79) и должен содержать следующие подпункты:
¨ Назначение программы
¨ Условия выполнения программы
¨ Выполнение программы и сообщение оператору
В подпункте «Назначение программы» указывается, для решения каких задач предназначена программа.
В подпункте «Условия выполнения программы» указывается, каике технические и программные средства необходимы для выполнения программы.
В подпункте «Выполнение программы и сообщение оператору»должны быть последовательно записаны действия оператора по запуску программы и ее выполнению. Указывается, как запустить программу, какое сообщение будет выведено на экран, и что нужно ввести в ответ на это сообщение. Должны быть рассмотрены все виды сообщений программы, в том числе сообщения об ошибках.