2018-01-08
476
При оформленні кодів програм щоб зробити їх зрозумілими та такими, що легко читаються, рекомендується додержуватись наступних правил:
1. Наявність горизонтальних відступів в тексті програми для відокремлення кожного блоку та вкладених в нього блоків. Відступи робляться за допомогою табуляції (клавіша TAB). За стандартом відступ дорівнює 4 пробілам.
2. Наявність вертикальних відступів, якими для зрозумілості розділяються логічні блоки. До таких логічних блоків можна, наприклад, віднести блок підключення заголовочних файлів, блок об’явлення змінних, блоки операторів вибору та циклів, функції и т. ін. Зазвичай один вертикальний відступ – це один пустий рядок.
3. Супроводження програми коментарями. Їх треба розміщувати в тих місцях програми, де виконуються якісь складні дії. Також коментарями слід починати кожну програму або функцію, для того щоб пояснити, які дії вони виконують. Але коментарі не повинні перефразовувати текст програми, їх призначення - пояснювати мету використання групи операторів, а не описувати дії, що виконують ці оператори.
4. При роботі з консоллю необхідно обов’язково виводити повідомлення (підказку) для користувача про те, які дії він повинен виконати, і про те, що виводить програма.
5. Наявність пробілів у коді. Зазвичай їх роблять довільно для покращання «читабельності» програм. За стандартом пробіл повинен бути після коми, крапки з комою, між логічними та арифметичними блоками, наприклад, до та після операцій +, -, =, >, <= і т. ін. Використовують їх і для позначення пріоритету виконання операцій, наприклад, краще написати a + b*c, ніж a + b * c.
6. Розміщення в одному рядку одного оператора. Хоча мова С дозволяє використання в одному рядку декількох операторів, це недоцільно робити з таких причин: погіршується «читабельність» програми та виникають труднощі в визначенні синтаксичних помилок, оскільки повідомлення про синтаксичну помилку вказує на номер рядка. Також в цьому випадку незручно проводити відладку програми, зокрема покрокове виконання програми, здійснювати контроль за зміною значень змінних та ін.
7. Правильний вибір імен у програмі. Всі об’єкти програми (змінні, функції, типи, іменовані константи і т. ін.) повинні мати обґрунтовані імена, що говорять про призначення того чи іншого об’єкту наприклад для позначення лічильника в програмі можна використати ім’я counter або increment. Не рекомендується іменувати об’єкти російським або українським транслітом. Хорошим тоном вважається використання англійських слів, наприклад краще використовувати імена maximum або max, а не maksimum. Якщо є обмеження на довжину імені, слід використовувати імена належної довжини. Не слід вживати однакові на вигляд імена, наприклад A10 та AIO.
Лістинги повинні мати порядкову нумерацію в межах кожного розділу. Номер лістингу повинен складатись з номеру розділу та порядкового номеру лістингу, розділених точкою, наприклад «Лістинг 3.2» - другий лістинг третього розділу.
Лістинги, розміщені в додатках, нумерують у межах кожного додатка, наприклад: «лістинг А.1.2 – другий лістинг першого розділу додатку А.
При посиланні на лістинг необхідно писати слово «лістинг» з зазначенням його номеру.
При оформленні лістингів слід використовувати шрифт Courier New, розмір – 12 пт, міжрядковий інтервал – одинарний. Назва лістингу друкується тим же шрифтом, що і основний текст, та розміщується над лістингом зліва, без абзацного відступу через тире після номеру лістингу. Крапка після назви не ставиться.
Приклад оформлення наведений у додатку Ж.
Лістинги розроблених студентом програм повинні розташовуватись в окремих додатках з обов’язковими посиланнями на них. Якщо розмір лістингу невеликий (не більше однієї сторінки) його можна розміщувати в основному тексті. В основній частині роботи для ілюстрації матеріалу, що викладається, повинні наводитись лістинги фрагментів програм, які треба розміщувати безпосередньо після тексту, в якому вони вперше згадуються або на наступній сторінці. На всі лістинги мають бути посилання в тексті роботи.
ДОДАТКИ
Додаток А
