Правила оформлення програм

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

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

Більшість мов програмування допускають довільне розміщення тексту програми. Але рекомендується обрати якесь однакове розміщення програмних об’єктів у тексті, оскільки таку програму легше писати та читати. Зокрема,

1. кожен оператор мови розміщується з нового рядка;

2. кожну внутрішню структуру оператора розміщують з однаковим послідовним зсувом;

3. якщо оператор не вміщується в один рядок, то продовження оператора у наступних рядках зсувають на одну й ту саму величину відносно початку оператора;

4. найкраще коментувати кожен змістовний оператор, текст коментаря повинен бути зрозумілим не тільки автору, складеним без скорочень, щоб було ясно, як працює модуль;

5. коментарі розміщують поряд із оператором за знаком початку коментаря, найкраще з однієї і тієї самої позиції;

6. якщо коментар не вміщується в одному рядку, то на рядку продовження коментаря не слід розміщувати наступний оператор, кожне продовження коментаря має свої позначки початку та кінця коментаря;

7. коли вибирають ім’я змінної або програми, бажано, щоб воно не тільки відповідало синтаксису мови, але й якось відображало відповідний зміст;

8. між окремими блоками (змістовними частинами) програми бажано залишати пусті рядки (для наочності).

Доцільно, щоб програма модуля складалася з 5 – 50 операторів (у середньому — з 20). Краще мати довшу, але простішу програму, аніж коротку та карколомну, «на кмітливість», бо вона принесе задоволення тільки автору в процесі створення, а не користувачеві в процесі експлуатації та супроводження.

Програма повинна бути «прозора». Якщо будь-яку дію можна запрограмувати різними способами, то перевага повинна віддаватися не більше компактному і навіть не найбільш ефективному, а такому, який легше для розуміння. Особливо це важливо тоді, коли пишуть програму одні, а супроводжують інші, що є широко поширеною практикою. «Непрозоре» програмування може спричинити величезні витрати на пошук помилок при налагодженні.

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

Для запису кожного фрагмента алгоритму необхідно використовувати найбільш відповідні засоби мови. Наприклад, розгалуження на декілька напрямків за значенням цілої змінної більш наочно записується за допомогою оператора switch, а не кількох if. Для перегляду масиву краще користуватися циклом for.

Коротшу гілку if краще помістити зверху, інакше вся керуюча структура може не поміститися на екрані, що ускладнить налагодження.

Слід уникати зайвих перевірок умов. Наприклад, замість

if (a<b) c=1;

else if (a>b) c=2;

else if (a=b) c=3;

краще написати

if (a<b) c=1;

else if (a>b) c=2;

else c=3;

Необхідно передбачати друк повідомлень в тих точках програми, куди управління при нормальній роботі програми передаватися не повинно. Наприклад, оператор switch повинен мати гілку default з обробкою ситуації за замовчуванням, особливо якщо в ньому перераховані всі можливі значення перемикача.

1Ініціалізація змінної – присвоєння їй початкового значення.

30