3.4 Разработка рабочего проекта
Этап разработки рабочего проекта включает в себя разработку программы и программной документации, а также испытание программы.
3.4.1 Разработка программы
Современные программы разрабатываются для функционирования в среде Windows. Приложение для Windows студенты разрабатывают в среде визуального программирования. Визуальное программирование строится на тесном взаимодействии двух процессов:
процесс конструирования Windows-окна;
процесс написания кода, придающего элементам этого окна и программе в целом необходимую функциональность.
Проект Windows-окна должен быть представлен в виде графической схемы, на которой расположены все визуальные и невизуальные компоненты, разрабатываемого интерфейса. Компоненты на схеме должны быть пронумерованы. После схемы приводится расшифровка изображенных на схеме компонентов: название и имя компонента; назначение в программе; события, на которые данный компонент откликается. Для каждого компонента должны быть указаны свойства, измененные при проектировании окна.
Пример
Для разработки приложения игры “Лабиринт” используется среда визуального программирования Delphi. Проект программы содержит три окна:
1. Form1 – перемещение по лабиринту.
2. Form2 – запись на диск плана помещений здания.
3. Form3 – запись на диск файла подсказки.
Окно Form1 Перемещение по лабиринту (рисунок 8).
Рисунок 8. Главное окно программы – Form1
Компонент Form1
Свойства:
Сaption – Игра “Лабиринт”;
Border – bsSingle;
BiSystemMenu – false;
BiMinimaze – false;
BiHelp – False;
События: нет.
1 – компонент TМainMenu
Свойства:
Items
Игра (N1) Настройка (N2) Выход (N3)
Ввод плана помещения (N4)
Ввод файла помощи (N5)
События:
Для N1 – событие BitBtn1Click (приводится ниже).
N3Click – закончить работу с приложением.
N4Click – перейти к работе со второй формой.
N5Click – перейти к работе с третьей формой.
2 – компонент TLabel1
Свойства:
Font – сиреневый, размер 12.
3 – компонент TEdit1
Свойства:
Text – очистить.
События:
Edit1KeyPress – защита от ввода недопустимых символов.
4 – компонент TBitBtn1
Свойства:
Caption – Game;
Glyph – Picture.Bmp.
События:
BitBtn1Click – ввод плана помещений из файла и организация структуры “Связанный список”. Выводит сообщение в метку Label1 и делает видимыми: Buttun1, Label1, Edit1.
5 – компонент TBitBtn2
Свойства:
Kind – bkClose
6 – компонент TPanel1
Свойства:
Align – alClient;
Caption – очистить;
Visible – False.
7 – компонент TPanel2
Свойства:
Align – alClient;
Caption – очистить;
Visible – False.
Компонент Image1 (на схеме не пронумерован).
Свойства:
Picture – Arches.Bmp;
Stretch – True;
Компонент Button1 (закрыт компонентом BitBtn1);
Свойства:
Caption – продолжить.
События:
Button1Click –ввод номера помещения, ввод имени файла помощи, показывает Panel2, прячет Edit1, Label1, Button1.
Контейнер Panel1 (рисунок 9).
Рисунок 9. Компонент Panel1
Перечисляются компоненты, расположенные в контейнере Panel1, их свойства и события.
Далее приводятся графические изображения других панелей и окон, перечисляются компоненты и их свойства.
Написание программы
Программную реализацию разработанных алгоритмов содержат обработчики событий. На этапе разработки рабочего проекта необходимая степень детализации алгоритмов обычно выбирается такой, чтобы предписания разработанных алгоритмов могли записываться на языке программирования, выбранном для составления текста программы. При детализации алгоритма необходимо перейти к обозначениям, принятым для разработки программ на алгоритмическом языке. При этом имена следует выбирать таким образом, чтобы они отражали сущность используемых параметров.
Кодирование должно быть простым. Изощренное программирование может обойтись слишком дорого при отладке и модификации программы. Необычное кодирование (например, использование скрытых возможностей машины) часто препятствует отладке программы и затрудняет ее использование другими программистами.
Программа должна быть по возможности универсальной. Универсальные программы обеспечивают независимость программы от конкретного набора данных. Например, универсальная программа использует в качестве параметров переменные, а не константы, обрабатывает вырожденные случаи и т. д.
Универсальность программы экономит время по дальнейшей работе над ней и обеспечивает широкие возможности по использованию. Разрабатывая такие программы, можно предвидеть будущие изменения в спецификациях этой программы.
Входные форматы должны быть разработаны с учетом максимального удобства для пользователя и минимальной возможности ошибок. Порядок переменных и форматы данных, привычные для пользователя, помогут избежать ошибок и облегчат использование программ.
При написании программы следует применять операторы, позволяющие использовать основные алгоритмические структуры. Оператор Goto желательно не использовать.
При написании программ не следует забывать о хорошем стиле программирования. После заголовка процедуры или функции записывается комментарий, содержащий поясняющий текст, а именно: назначение подпрограммы; перечень и назначение формальных параметров, их тип. Комментариями должны быть снабжены и основные смысловые блоки программы или подпрограммы.
Для облегчения чтения текста программы отдельные операторы программы записываются с отступом.
Пример
Обработчик BitBtn1Click.
Для построения детальной схемы алгоритма необходимо определить структуру элемента списка и ввести обозначения.
Предлагается следующая структура элемента списка помещений:
Room = Record Num: Integer;
Door: Array [Trend] Of Uk;
Next: Uk;
End;
Поле Num хранит номер помещения; массив Door предназначен для хранения ссылок на смежные комнаты; поле Next содержит ссылку на следующий элемент списка. Trend – это перечисляемый тип данных, имеющий следующие значения: nord, ost, zued, west. Эти значения соответствуют направлениям дверей, которые могут быть расположены в каждом помещении. Указатель на начало списка помещений обозначим идентификатором Spi. Spi – глобальная переменная, которая описана в головной части программы.
Схема алгоритма построения связанного списка приведена на рисунке 10.
Рисунок 10. Построение связанного списка
Схема алгоритма построения многосвязанного списка приведена на рисунке 11.
Рисунок 11. Схема алгоритма построение многосвязанного списка,
содержащего в себе план помещений здания
Программа.
procedure TForm1. BitBtn1Click (Sender: TObject);
// Построение связанного списка помещений
Var FileName: TNameFile; f: TextFile;
p: Uk; i, nr: Integer;
begin
FileName:= InputBox(‘План помещений’, ‘Введите имя файла ‘,’’);
AssignFile(f, FileName);
Reset(f);
//Считываем только номера помещений и составляем связанный список
Spi:= nil;
While not Eof(f) Do
Begin
New(p);
Readln(f, i);
p^.Num:= i;
For r:= nord To west Do p^.Door [r]:= nil;
p^.next:= Spi;
Spi:= p;
End;
//Еще раз считываем из файла, но уже с дверьми
Reset (f);
While not Eof(f) Do
Begin
Read(f, i);
p:= Nroom(Spi, i);
For r:= nord To west Do
Begin Read(f, nr);
If nr = 0 Then p^.Door[r]:= nil
Else p^.Door[r]:= Nroom(Spi, nr);
End;
End;
// Подготовка формы для ввода номера начала помещения
label1.Caption:= ‘Введите № комнаты, с которой хотите начать движение’;
Edit1.Visible:= True;
label1.Visible:= True;
Button1.Visible:= True;
end;
Функция Nroom – поиск ссылки на помещение с заданным номером. В начинающемся в Spi списке помещений по номеру помещения N отыскивается нужное. Значение функции указывает на это помещение. Схема алгоритма приведена на рисунке 12.
Рисунок 12. Схема алгоритма функции Nroom
Программа
Function Nroom(Spi: Uk; n: Integer): Uk;
// В списке помещений находим указатель на n - oe
Var q: Uk;
Begin
q:= Spi;
While (q<>nil) and (q^.num<>n) Do q:= q^.next;
Nroom:= q;
End;
Аналогично уточняются все алгоритмы и разрабатываются обработчики событий.
Примечание - не следует представлять в виде схем алгоритмов линейные вычислительные процессы. В детализированном виде представляются алгоритмы, имеющие сложную структуру. Сложной структурой будем считать алгоритмы, содержащие более одного разветвления или более одного цикла.
3.4.2 Спецификация программы
В разделе спецификация приводится точное название программы и ее состав. Форма спецификации приведена в приложении А. Графы спецификации заполняют следующим образом:
- в графе “Обозначение” указывают обозначение основных программных компонентов;
- в графе “Наименование” - полное наименование соответствующего компонента;
- в графе “Примечание” – дополнительные сведения, относящиеся к записанным в специи-фикации программам.
Пример
Исполняемый файл программы “Игра “Лабиринт” имеет название Labirint.exe и расположен на компакт-диске (дискете) в каталоге Kursov\Labirint. Состав проекта.
3.4.3 Текст программы
Приводится полный листинг программы.
Пример листинга:
unit Unit1;
interface
uses
Windows, Messages, SysUtils, Classes, Graphics, Controls, Forms, Dialogs,
StdCtrls, Buttons, Menus, ExtCtrls;
type
TForm1 = class(TForm)
Image1: TImage;
MainMenu1: TMainMenu;
N1: TMenuItem;
N2: TMenuItem;
N3: TMenuItem;
BitBtn1: TBitBtn;
BitBtn2: TBitBtn;
Panel1: TPanel;
Label1: TLabel;
Edit1: TEdit;
Label2: TLabel;
Label3: TLabel;
BitBtn3: TBitBtn;
Label4: TLabel;
BitBtn4: TBitBtn;
BitBtn5: TBitBtn;
BitBtn6: TBitBtn;
BitBtn7: TBitBtn;
BitBtn8: TBitBtn;
Panel2: TPanel;
Memo1: TMemo;
ListBox1: TListBox;
Button1: TButton;
N4: TMenuItem;
N5: TMenuItem;
Label5: TLabel;
procedure BitBtn1Click(Sender: TObject);
procedure Edit1KeyPress(Sender: TObject; var Key: Char);
procedure BitBtn3Click(Sender: TObject);
procedure BitBtn7Click(Sender: TObject);
procedure ListBox1Click(Sender: TObject);
procedure Button1Click(Sender: TObject);
procedure N4Click(Sender: TObject);
procedure N3Click(Sender: TObject);
procedure N5Click(Sender: TObject);
private
{ Private declarations }
public
{ Public declarations }
end;
var Form1: TForm1;
//Перечисляемый тип для определения направления движения
Type Trend = (nord, ost, zued, west);
// Структура элемента списка
Uk = ^Room;
Room = Record Num: Integer;
Door: Array [Trend] Of Uk;
Next: Uk;
End;
// Структура компонента файла помощи
THelp = Record v: String[100];
otv: Array [1..4] Of String[100];
End;
TNameFile = String[20];
Var Spi, pp, Iroom: Uk;
r: Trend; ff: File Of THelp;
// Spi – указатель на начало списка; pp, Iroom –рабочие указатели;
// r – для определения направления движения;
// ff – файловая переменная для обращения к файлу помощи.
implementation
Uses Unit2, Unit3;
{$R *.DFM}
Function Nroom(Spi: Uk; n: Integer): Uk;
// В списке помещений находим указатель на n - oe
Var q: Uk;
Begin
q:= Spi;
While (q<>nil) and (q^.num<>n) Do q:= q^.next;
Nroom:= q;
End;
procedure TForm1.BitBtn1Click(Sender: TObject);
// Построение связанного списка помещений
Var FileName: TNameFile; f: TextFile;
p: Uk; i, nr: Integer;
begin
FileName:= InputBox(‘План помещений’,’Введите имя файла ‘,’’);
AssignFile(f, FileName);
Reset(f);
//Считываем только номера помещений и составляем связанный список
Spi:= nil;
While not Eof(f) Do
Begin
New(p);
Readln(f, i);
p^.Num:= i;
For r:= nord To west Do p^.Door [r]:= nil;
p^.next:= Spi;
Spi:= p;
End;
//Еще раз считываем из файла, но уже с дверьми
Reset (f);
While not Eof(f) Do
Begin
Read(f, i);
p:= Nroom(Spi, i);
For r:= nord To west Do
Begin Read(f, nr);
If nr = 0 Then p^.Door[r]:= nil
Else p^.Door[r]:= Nroom(Spi, nr);
End;
End;
// Подготовка формы для ввода номера начала помещения
label1.Caption:= ‘Введите № комнаты, с которой хотите начать движение’;
Edit1.Visible:= True;
label1.Visible:= True;
Button1.Visible:= True;
end;
procedure TForm1.Edit1KeyPress(Sender: TObject; var Key: Char);
// Защита от недопустимых символов (вводятся только цифры)
begin
If not (key in [‘1’..’9']) Then Key:= #27;
end;
procedure TForm1.BitBtn3Click(Sender: TObject);
// Перемещение. BitBtn3 – север; BitBtn4 – запад;
//BitBtn5 – восток; BitBtn6 – юг.
Var aa: String[8]; c: Integer; pp: Uk;
//aa – имя кнопки; c – номер кнопки;
//pp – указатель текущего помещения.
begin
pp:= Iroom;
aa:= (sender as TBitBtn).Name;
c:= StrToInt(Copy(aa,7,1));
Case c of
3: r:= nord;
5: r:= ost;
6: r:= zued;
4: r:= west;
End;
Iroom:= Iroom^.Door[r];
If Iroom = nil Then
Begin ShowMessage(‘Это невозможно!’);Iroom:= pp; End
Else Label3.Caption:= IntToStr(Iroom^.Num);
Label4.Caption:= IntToStr(Iroom^.Num);
If Iroom^.Num = 999 Then
Begin ShowMessage(‘Свобода!!!’);
Panel1.hide; label1.Hide; Button1.Hide;
Exit End;
end;
procedure TForm1.BitBtn7Click(Sender: TObject);
// Вывод содержимого справки в компоненты панели Panel2
Var i: Integer; a: THelp;
Begin
Panel1.Visible:= False;
Panel2.Visible:= True;
Label5.Caption:= IntToStr(Iroom^.Num);
// Устанавливаем указатель текущего компонента файла
Reset(ff); Seek(ff, Iroom^.Num - 1);
Read(ff, a); Memo1.Lines.Add(a.v);
For i:= 1 To 4 Do ListBox1.items[i]:= a.otv[i];
end;
procedure TForm1.ListBox1Click(Sender: TObject);
//Определение направления путем выбора верного ответа в списке
Var r1: Trend;
begin
pp:= Iroom;
Panel2.Visible:= False;
Panel1.Visible:= True;
for r1:= nord To west Do
If ListBox1.ItemIndex = ord(r1) + 1 Then r:= r1;
Iroom:= Iroom^.Door[r];
If Iroom = nil Then
Begin ShowMessage(‘Это невозможно!’);Iroom:= pp; End
Else Label3.Caption:= IntToStr(Iroom^.Num);
Label4.Caption:= IntToStr(Iroom^.Num);
If Iroom^.Num = 999 Then
Begin Writeln(‘Свобода!!!’);
Panel1.hide; label1.Hide; Button1.Hide;
Exit End;
end;
procedure TForm1.Button1Click(Sender: TObject);
// Ввод номера начала помещения
Var nr: Integer; FileName: TNameFile;
// nr – номер помещения для начала движения
// File Name – имя файла помощи
begin
If Edit1.Text = ‘’ Then Exit;
nr:= StrToInt(Edit1.Text);
Iroom:= Nroom(Spi, nr);
If Iroom = nil Then
Begin
ShowMessage(‘Такого помещения нет!’);
Edit1.Text:= ‘’; Label1.Caption:= ‘’;
Exit;
End;
panel1.Visible:= True;
Label3.Caption:= IntToStr(Iroom^.Num);
Label4.Caption:= IntToStr(Iroom^.Num);
FileName:= InputBox(‘Имя файла помощи’, ‘Введите имя файла помощи’,’’);
AssignFile(ff, FileName);
Edit1.Hide; Label1.Hide; Button1.Hide;
end;
procedure TForm1.N4Click(Sender: TObject);
// Переход к форме №2, осуществляющей запись плана помещений на диск.
Begin
Form1.Hide; Form2.Show;
End;
procedure TForm1.N3Click(Sender: TObject);
//Закрыть приложение
begin
Form1.Close; Form2.Close; Form2.Close;
Application.Terminate;
end;
procedure TForm1.N5Click(Sender: TObject);
//Переход к форме №3, осуществляющей запись на диск файла помощи.
begin
Form1.Hide; Form3.Show;
end;
end.
Далее приводятся листинги остальных модулей.
3.4.4 Описание программы
Раздел “Описание программы” согласно ГОСТ 19.402–78* должен содержать следующие подразделы:
· общие сведения;
· функциональное назначение;
· описание логической структуры;
· используемые технические средства;
· вызов и загрузка;
· входные данные;
· выходные данные.
Отдельные разделы можно объединять. Некоторые пункты этого раздела повторяют разделы технического проекта. Такие повторения предусмотрены ГОСТом, так как на этапе рабочего проекта возникают некоторые дополнения или изменения в составе технических средств или программе. Здесь приводятся более конкретные и точные данные.
В подразделе “Общие сведения” должны быть указаны: обозначение и наименование программы; программное обеспечение, необходимое для функционирования программы; языки программирования, на которых написана программа.
В подразделе “Функциональное назначение” должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.
В подразделе “Описание логической структуры” должны быть указаны используемые методы; структура программы с описанием функций составных частей и связи между ними; связи программы с другими программами. Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
В подразделе “Используемые технические средства” должны быть указаны типы ЭВМ и устройств, которые используются при работе программы.
В подразделе “Вызов и загрузка” должны быть указаны способ вызова программы с соответствующего носителя данных, входные точки в программу.
В подразделе “Входные данные” должны быть указаны: характер, организация и предварительная подготовка входных данных, формат, описание и способ кодировки входных данных.
В подразделе “Выходные данные” должны быть указаны: характер, организация и предварительная подготовка выходных данных, формат, описание и способ кодировки выходных данных.
3.4.5 Тестирование программы
Перечисляются требования, подлежащие проверке при испытании программы, а также порядок и методика их контроля. Приводятся исходные данные для решения контрольного примера и ожидаемые результаты.
Прилагается распечатка решения контрольного примера и снимки экрана с результатами тестирования.
|