0.Методичні вказівки до оформлення звітів з лабораторних робіт

Виконання завдань кожної роботи і звіти з них складаються з п’яти розділів, які спрощено відповідають етапам розробки програмної продукції, що зафіксовані Єдиною системою програмної документації.

Перший розділ - “постановка задачі” - містить повний опис взємодії програми з користувачем, а також опис методів обчислень. В цьому розділі необхідно перелічити вхідні дані програми, вказати, які значення та повідомлення будуть виводитись на друк або на екран, при необхідності подати ескіз полів виводу даних на екрані. При описі методів обчислень необхідно вивести кінцеві розрахункові формули або рівняння для обчислення результату, вказати рекомендовані методи розв’язку рівнянь. Необхідно також вказати критерій оптимізації розроблюваної програми (кількість виконуваних операцій, час виконання, обсяг використаної пам’яті, обсяг тексту програми) та шляхи досягнення оптимального рішення. Перший розділ обов’язково виконується природною мовою з використанням загальноприйнятих математичних (не програмних!) позначень.

В умовах промислового виготовлення програмної продукції постановка задачі є самостійним документом - технічним завданням на програмування.

Другий і третій розділи “розробка структури даних” та “розробка алгоритму” фіксують дві різні складові одного неподільного процесу розробки програми, а саме: відведення пам’яті для зберігання значень, необхідних при розрахунках (впровадження і позначення змінних) та встановлення порядку обробки цих значень.

Результати “розробки структури даних” фіксуються у вигляді таблиці:

Табл. 0.1. Структура даних.

Позначення в задачі	Ім’я в пограмі	Тип	Призначення
1	2	3	4

В колонку 1 заносяться позначення змінних, використані в першому розділі при математичному описі задачі, або ставиться прочерк, коли задача поставлена природною мовою. Колонка 2 містить імена змінних і заповнюється при виконанні 4-го розділу, оскільки імена залежать від обраної мови програмування. Для зменшення ймовірності похибок і полегшення розуміння програми необхідно вводити мнемонічні імена, написання яких або подібне до позначення, або натякає на призначення. В колонці 3 описується тип змінної (ціла, дійсна, символьна), необхідний для реалізації її призначення. Тип може уточнюватись в залежності від обраної мови програмування. Для структурованих змінних із однотипних елементів (масиви, стеки, файли) описується розмір, тип і границі індексу а також тип елементів. Індекси описуються також як окремі змінні. Для записів окремо описується тип і призначення кожного поля. Колонка 4 містить опис (по можливості природньою мовою), який пов’язує відповідну змінну з поставленою задачею (наприклад: номер рядку, n-ий член ряду, аргумент, запит оператору). Змінні, значення яких вводяться ззовні, або повідомляються користувачу чи іншій програмі, додатково позначаються як “вхідна” або “вихідна” відповідно. Результати “розробки алгоритму” подаються у вигляді блок-схеми алгоритму з використанням таких позначень:

Рис. 0.1. Умовні позначення для виконання блок-схем.

При складанні алгоритму необхідно додержуватися правил структурного програмування, тобто використовувати тільки стандартні керуючі структури: послідовність (Рис. 0 .2); альтернатива (Рис. 0 .3); цикли “поки”, “до” і з параметром (Рис. 0 .4).

Рис. 0.2. Послідовність.

Рис. 0.3. Альтернатива.

Рис. 0.4. Цикли.

Кожна з описаних структур має один вхід і один вихід, що дозволяє об’єднувати їх в необхідній послідовності. Крім того, “дії”, вказані в кожній зі структур, можуть бути як операторами, так і керуючими структурами будь-якого типу. Така побудова алгоритму забезпечує краще розуміння послідовності дій, зменшення ймовірності помилки, зменшення кількості операторів безумовного переходу при написанні тексту програми.

При складанні алгоритму необхідно виконати такі вимоги:

• виводити на екран вхідні дані безпосередньо після їх введення;

• не модифікувати вхідні дані до завершення програми;

• формувати значення результату в пам’яті ЕОМ (у відведених для цього змінних) і тільки по завершенні розрахунків виводити на друк;

• визначати і позначати на блок-схемі контрольні точки, тобто місця, в яких зручно було б вставляти друк проміжних значень змінних при налагоджуванні програми.

У четвертому розділі - “запис тексту програми” – наводиться текст розробленої програми на мові Паскаль. Обов’язковою вимогою до текстів програм є наявність коментарів, які вказують початок та закінчення керуючих структур та функціональне призначення окремих команд програми. Коментарі описуються у фігурних дужках в Паскалі: {Це коментар}.

В записі тексту програми пропуски позначаються знаком , цифри 0, 3, 5 перекреслюються, літери записуються шрифтом, який би виключав їх неоднозначне прочитання (наприклад: е, l; B, 8;1,I,T).

В тексті Паскаль-програми необхідно вводити різну кількість відступів від початку рядку для виділення дій, які відносяться до різних керуючих структур. Самі керуючі структури однозначно записуються за допомогою стандартних операторів мови Паскаль з використанням складеного оператору begin...end.

Текст кожної підпрограми (якщо вони використовуються) виділяється підзаголовком-коментарем.

Останній розділ - “налагодження та результати тестування” - оформлюється під час виконання лабораторної роботи. Розділ містить перелік помилок, виявлених під час трансляції та виконання програми з поданням виправленого варіанту, а також результати розрахунків тестових прикладів.

Тестових прикладів має бути мінімум два: наведений у завданні до роботи, та з іншими вхідними даними. Дані для тестів необхідно вибрати так, щоби були використані всі розгалуження блок-схеми.

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