Как лучше делать описание к программе? Описание программы

21.4. Пример программы на С В п. 9.2.3 я сказал о состояниях процесса и перечислил среди них состояние «зомби». Зомби - это процесс, который уже завершился, но его родитель еще не получил сигнала о его завершении и не удалил его структуру из таблицы процессов. Такое может

22.3. Пример отладки программы Давайте напишем программу, которая обнуляет элементы массива a. Да, программа ничего полезного не делает, но на ее примере можно продемонстрировать работу с отладчиком gdb.Вот листинг программы:Листинг 22.1. Демонстрационная программа,

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

ПРИМЕР ПРОСТОЙ ПРОГРАММЫ НА ЯЗЫКЕ СИ Давайте рассмотрим простую программу на языке Си. Следует сразу сказать, что такой пример нужен нам лишь для выявления некоторых основных черт любой программы, написанной на языке Си. Далее мы дадим пояснения к каждой строке, но, перед

ПРИМЕР ПРОГРАММЫ На рис. 5.8 приведена программа, которая может оказаться полезной тем, кто занимается бегом, и которая иллюстрирует некоторые положения данной главы. Она выглядит довольно длинной, но все вычисления в ней выполняются шестью операторами, помещенными

5.1.6. Пример программы Программа, приведенная в листинге 5.1, иллюстрирует методику совместного использования памяти.Листинг 5.1. (shm.c) Пример совместного использования памяти#include #include #include int main() { int segment_id; char* shared_memory; struct shmid_ds shmbuffer; int segment_size; const

Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД) . ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.

Краткий алгоритм оформления программы

Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.

Оформление программного документа

Программный документ - документ, содержащий сведения, необходимые для разработки, изготовления, сопровождения и эксплуатации программ.

Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77 , ГОСТ 19.103-77 , ГОСТ 19.104-78 , ГОСТ 19.105-78 , ГОСТ 19.106-78 , ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.

Общие требования к программным документам. ГОСТ 19.105 - 78

Требования к программным документам, выполненным печатным способом. ГОСТ 19.106 - 78

ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.

Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".

Материалы программного документа должны располагаться в следующей последовательности :

• Титульная часть:
  • лист утверждения (не входит в общее количество листов документа);
  • титульный лист (первый лист документа);
• Информационная часть:
  • аннотация;
  • лист содержания;
• Основная часть:
  • текст документа (с рисунками, таблицами и т.п.);
  • приложения;
  • перечень терминов, перечень сокращений, перечень рисунков, перечень таблиц, предметный указатель, перечень ссылочных документов;
  • часть регистрации изменений:
  • лист регистрации изменений.

В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.

Форматирование текста:

• Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
• Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
• Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
• Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
• Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
• Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
  • при выполнении документа машинописным способом - двум интервалам.
• Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
  • при выполнении документа машинописным способом - трём машинописным интервалам.
• Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
• В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
• Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
• При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
• Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
• Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
• Необходимые пояснения к тексту документа могут оформляться сносками.
• Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
• Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
• Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
• Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
• Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
• В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
• Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
• В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
• Одно примечание не нумеруется. После слова «Примечание» ставят точку.
• Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
• Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
• Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
• Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.

В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.

3. ОПИСАНИЕ СТРУКТУРЫ ПРОГРАММЫ

Описание переменных

В разделе описаний переменных описаны переменные, назначение которых приведено в таблице 3.1.

Таблица 3.1– Описание переменных программы

В программе приведено описание одной вспомогательной процедуры.

Процедура FormCreate вывода исходных значений в компоненты формы для корректного отображения формы в начале работы программы.

Процедура Button1Click для отрытия исходного файла и сохранения пути к нему.

Процедура Button2Click для отрытия результирующего файла и сохранения пути к нему.

Алгоритм основной программы

Алгоритм выполнения основного тела программы приведен на рисунке А.1 в приложении А. Так в процедуре в первую очередь осуществляется привязка файла к файловой переменной и открытие текстового файла для чтения текстовой информации.

Затем производится чтение информации из файла построчно.

Затем в каждой строке выделяются слова.

Затем осуществляется поиск в выделенных словах заглавных символов.

Затем происходит запись в результирующий текстовый файл изменений.

В ходе выполнения работы использовались следующие операции работы с текстовыми файлами:

AssignFile (<Имя файловой переменной>,<Имя файла>);

Имя файла задается либо строковой константой, либо через переменную типа Sting. Имя файла должно соответствовать правилам работающей в данный момент операционной системы. Если строка имени пустая, то связь файловой переменной осуществляется со стандартным устройством ввода-вывода.

Reset (<Имя файловой переменной>);

Открывается файл для чтения из него информации, ему присваивается имя, заданное процедурой Assign.

После работы с файлом он, как правило, должен быть закрыт процедурой CloseFile (<Имя файловой переменной>). Вывод информации производит оператор WRITELN(f: TextFile;S: String). После его выполнения строка S заносится в конец файла, связанного с переменной f.

4. ОПИСАНИЕ ВХОДНЫХ ДАННЫХ

Исходными данными для выполнения является файл, который содержит заглавные символы.

5. ОПИСАНИЕ ВЫХОДНЫХ ДАННЫХ

Выходными данными являются:

Сообщение о завершении проверки файла на наличие в нем заглавных символов;

Сообщение о количестве исправленных символов;

Заполненный результирующий текстовый файл.

6. ИНСТРУКЦИЯ ОПЕРАТОРУ

Разработанная программа представляет собой исполняемый файл Luchshev.exe размером 405 Кбайт. В программе реализован алгоритм проверки текстового файла на наличие в нем заглавных символов.

После запуска программы появляется окно, изображенное на рисунке 4.1.

Рисунок 4.1 – Главное окно программы

После этого пользователь должен задать путь к файлу. На рисунке 4.2 показан пример диалогового окна для открытия файла.

Рисунок 4.2 – Пример отскрытия исходного файла

Пример сообщения о нахождении заглавного символа приведен на рисунке 4.3.

Рисунок 4.3– Сообщение о нахождении заглавного символа

Пример окна с результатом проверки текстового файла приведен на рисунке 4.4.

Рисунок 4.4- Результирующее окно.

Результат проверки записывается в выбранный результирующий файл находящийся в выбранной директории.

Функционирование программы полностью соответствует заданию.

Данная курсовая работа была выполнена в полном соответствии поставленному заданию и отлажена в среде Delphi 7.0. В ходе выполнения курсовой работы была разработана программа для проверки текстового файла.

В ходе выполнения курсового проекта были проведен - анализ технического задания и постановка задачи проектирования.

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

Был разработан алгоритм программы, предназначенной для выполнения сформированных функций.

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

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

В ходе разработки программы были закреплены навыки работы:

Командами ввода-вывода как на экран, так и в текстовые файлы,

Использования процедур,

Команды обработки массивов,

Команды для реализации циклов с заданным числом повторений;

Команды проверки условий и реализации ветвлений.

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

Перечень ссылок

1. Зуев Е.А. Программирование на языке Delphi 6.0,7.0. – М.: Радио и связь, Веста, 1993.

2. Фаронов В.В. Delphi 7.0. Начальный курс. - М.: Нолидж, 2000.

Алгоритм программы

Рисунок А.1 – Алгоритм программы

Рисунок А.2 – Алгоритм основной процедуры программы

ПРИЛОЖЕНИЕ Б

Листинг программы

4. Windows, Messages, SysUtils, Variants, Classes, Graphics, Controls, Forms,

5. Dialogs, StdCtrls;

7. TForm1 = class(TForm)

8. Button1: TButton;

9. Button2: TButton;

10. OpenDialog1: TOpenDialog;

11. SaveDialog1: TSaveDialog;

12. Button3: TButton;

13. Label1: TLabel;

14. Label2: TLabel;

15. Label3: TLabel;

16. Label4: TLabel;

17. Button4: TButton;

18. procedure Button1Click(Sender: TObject);

19. procedure Button2Click(Sender: TObject);

20. procedure FormCreate(Sender: TObject);

21. procedure Button3Click(Sender: TObject);

22. procedure Button4Click(Sender: TObject);

24. { Private declarations }

26. { Public declarations }

29. Form1: TForm1;

30. OFName,SFName:String;

31. implementation

33. procedure TForm1.Button1Click(Sender: TObject);

35. if OpenDialog1.Execute then

36. OFName:=OpenDialog1.FileName;

37. if OFName<>"" then begin

38. Button1.Enabled:=False;

39. Button2.Visible:=True;

40. Label1.Caption:="Путь к файлу для проверки: "+OFName;

41. Label2.Visible:=True;

45. procedure TForm1.Button2Click(Sender: TObject);

50. if SaveDialog1.Execute then

51. SFName:=SaveDialog1.FileName;

52. if Pos(".txt",SFName)=0 then SFName:=SFName+".txt";

53. if SFName=OFName then

54. ShowMessage("Выберите другой файл для сохранения результата")

57. if (SFName<>"") and (b) then begin

58. Button2.Enabled:=False;

59. Label2.Caption:="Путь к результирующему файлу: "+SFName;

60. Button3.Visible:=True;

61. Label3.Visible:=True;

62. Label3.Caption:="Для начала проверки нажмите на кнопку "Проверить"";

65. procedure TForm1.FormCreate(Sender: TObject);

67. Button2.Visible:=False;

68. Label2.Visible:=False;

69. Button3.Visible:=False;

70. Label3.Visible:=False;

71. Button4.Visible:=False;

72. Label4.Visible:=False;

73. Label1.Caption:="Нажмите на кнопку "Открыть" и выберите файл для проверки";

75. procedure TForm1.Button3Click(Sender: TObject);

77. FO,FS:TextFile;

78. i,j,count:integer;

79. str,strslovo,tmpstr:String;

80. ZnCh,UpCh:set of Char;

84. ZnCh:=[".",",","!","?"];

85. UpCh:=["A".."Z","А".."Я"];

86. AssignFile(FO,OFName);

87. AssignFile(FS,SFName);

91. if IOResult<>0 then begin

92. ShowMessage("Произошли проблемы с открытием файла. Программа будет завершена");

96. Rewrite(FS);

97. while not Eof(FO) do begin

98. Readln(FO,str);

99. strslovo:="";

100. for i:=1 to Length(str) do begin

101. if (str[i] in ZnCh) or (str[i]=" ") then begin

102. for j:=1 to Length(strslovo) do begin

a. if strslovo[j] in UpCh then begin

b. answ:=MessageDlg("В слове ""+strslovo+"" найдена заглавная буква ""+strslovo[j]+"". Заменить ее на малую?",mtInformation,,0);

c. if answ=mrYes then begin

i. tmpstr:=strslovo[j];

ii. tmpstr:=AnsiLowerCase(tmpstr);

iii. Delete(strslovo,j,1);

iv. Insert(tmpstr,strslovo,j);

104. Write(FS,strslovo+str[i]);

105. strslovo:="";

108. strslovo:=strslovo+str[i];

110. Writeln(FS,"");

112. CloseFile(FO);

113. CloseFile(FS);

114. Label3.Caption:="Проверка файла завершена. Исправлено "+IntToStr(count)+" заглавных букв.";

115. Button3.Enabled:=False;

116. Button4.Visible:=True;

117. Label4.Visible:=True;

120. procedure TForm1.Button4Click(Sender: TObject);

122. OFName:="";

123. SFName:="";

124. Button1.Enabled:=True;

125. Button2.Visible:=False;

126. Button2.Enabled:=True;

127. Button3.Visible:=False;

128. Button3.Enabled:=True;

129. Button4.Visible:=False;

130. Label2.Visible:=False;

131. Label3.Visible:=False;

132. Label4.Visible:=False;

133. Label1.Caption:="Нажмите на кнопку "Открыть" и выберите файл для проверки";

Результаты решения программы

Текст программы

Пример.

Спецификация программы

В разделе спецификация приводится точное название программы и ее состав. Форма спецификации приведена в приложении 2. Графы спецификации заполняют следующим образом:

1. в графе "Обозначение" указывают обозначение основных программных
компонентов;

2. в графе "Наименование" указывают полное наименование соответствующего компонента;

3. в графе "Примечание" - дополнительные сведения, относящиеся к записанным в спецификации программам.

Исполняемый файл программы "Игра "Лабиринт"" имеет название Labirint.exe и расположен на диске F в каталоге Student\Kursov\Labirint. Состав проекта:

Приводится полный листинг программы. Приводятся листинги всех модулей с комментариями.

Раздел "Описание программы" согласно ГОСТ 19.402-78 должен содержать следующие подразделы:

· общие сведения;

· функциональное назначение;

· описание логической структуры;

· используемые технические средства;

· входные данные;

· выходные данные.

Отдельные разделы можно объединять. Некоторые пункты этого раздела повторяют разделы технического проекта. Такие повторения предусмотрены ГОСТом, так как на этапе рабочего проекта возникают некоторые дополнения или изменения в составе технических средств или программе. Здесь приводятся более конкретные и точные данные.

В подразделе "Общие сведения" должны быть указаны: обозначение и наименование программы; программное обеспечение, необходимое для функционирования программы; языки программирования, на которых написана программа.

В подразделе "Функциональное назначение" должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.

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

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

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

В подразделе "Входные данные" должны быть указаны: характер, организация и предварительная подготовка входных данных, формат, описание и способ кодировки входных данных.

В подразделе "Выходные данные" должны быть указаны: характер, организация и предварительная подготовка выходных данных, формат, описание и способ кодировки выходных данных.

Чтобы описать программу , начните с общего вступления. Опишите основную проблему, с которой сталкивается пользователь. Естественно, это должна быть та самая проблема, которую и решает описываемая программа. Кстати это хороший способ сразу же очертить целевую аудиторию пользователей. Те, кому она будет полезна и необходима, ее скачают или купят. Другие же пользователи сэкономят время и не станут далее читать. Также во вступлении кратко опишите основные возможности программы. Для этого достаточно 1-2 предложений.

Укажите системные требования к компьютерному оборудованию. Чтобы наиболее полно описать программу , сделайте градацию. Распишите минимальные требования и требования для комфортной работы.

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

Невозможно описать программу , не рассказав подробно о ее основных функциях. Это можно сделать в виде списка или перечня. Однако важно в данном пункте соблюдать конкретику. К примеру, фраза «эффективная работа с проектами» не несет в себе никакой смысловой нагрузки. Точнее, смысловая нагрузка, конечно, есть, но она относительна и не сообщает читателю никаких фактов.

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

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

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