Стиль програмування
План
Стиль програмування
2. Правила написання коментарів.
3. Використання пробілів та порожніх рядків.
4. Використання табуляції.
5. Мнемоніка ідентифікаторів.
6. Розміщення операторів.
7. Використання дужок.
8. Використання відступів.
Література
1. Стиль програмування
Стиль в програмуванні – це прийоми та правила написання коду, тобто тексту програми. Правила хорошого стилю – це результат колективного досвіду багатьох програмістів, в певному розумінні частина програмістського ремесла. Зрозуміло, що “на смак та колір товаришів немає...”, але, спираючись на досвід та здоровий глузд, узгодимо та станемо дотримуватись певних вимог при створенні текстів програм. Основне правило хорошого стилю: програма повинна бути зрозумілою людям, бо саме вони використовують та супроводжують її роками. Почнемо з того, чого більшість авторів програм намагається позбігтися, або принаймні відкласти “на потім”.
2. Правила написання коментарів.
Найбільш ефективним засобом полегшення розуміння програми є її коментування. Проте програмісти, особливо ті, кому не доводилося перевіряти чи модифікувати чужі (або навіть свої, але через порівняно великий проміжок часу) програми, часто уникають написання коментарів з метою економії часу.
“Некоментована програма – це найгірша помилка, яку може зробити програміст, а також свідоцтво дилетантського підходу (нехай навіть цей програміст має десятирічний досвід роботи)” [5].
Коментарі слід писати саме під час написання програми, бо з часом суттєві деталі програми можуть забутись. Можна вважати, що програма є добре відкоментованою, якщо при першому знайомстві з нею можна зрозуміти структуру програми, її суть і логіку роботи, лише переглядаючи керівні структури і читаючи коментарі, не аналізуючи детально оператори, які задають правила обробки даних.
Головне – не кількість коментарів, а їх якість. Коментарі мають допомагати читати програму. Вони зайві, якщо повторюють те, що й так зрозуміло з тексту програми, або просто шкідливі, якщо йому суперечать. Так, абсолютно некорисним буде коментар вигляду:
(*перевірити, чи величина від’ємна*)
if (d < 0) then …
на відміну від, наприклад, такого:
(*якщо дискримінант від’ємний, то дійсних коренів не існує*)
if (d < 0) then …
В останньому випадку коментар пояснює не те, що робить програма (будь-хто, знайомий з синтаксисом умовного оператору, це зрозуміє), а прояснює, навіщо потрібна дана перевірка.
Коментарів вимагають цикли, розгалуження, оригінальні ідеї та моменти, пов’язані з особливостями мови програмування. В наступному прикладі неочевидним чином використовується цілочисленне ділення мови С. (Більше про стиль програмування стосовно саме мови С можна знайти в [2]).
Приклад (мова С):
/* ініціалізуємо масив: А – одинична матриця*/
for (i = 0; i < n; i++)
for (j = 0; j < n; j++)
А[i][j] = (i/j)*(j/i);
Для виділення змісту коментаря в тексті програми можна використовувати блоки, які вирівняні по вертикалі. Наприклад:
/**********************************************/
/* так розташований коментар */
/* виділяється в тексті програми */
/**********************************************/
До цього часу ми говорили про пояснювальні коментарі. Крім них, обов’язковими є коментарі-заголовки для модулів (які повинні включати в себе, як мінімум, визначення задачі, яку розв’язує даний модуль, і приклад виклику з фактичними параметрами). Корисним також є вступний коментар для програми. Він повинен містити відомості про:
призначення програми;
перелік і призначення змінних програми;
вказівки по вводу-виводу;
опис методу або літературні джерела;
приблизний час роботи програми;
необхідний об’єм пам’яті;
відомості про авторів;
дату внесення останніх змін в програму.
3. Використання пробілів та порожніх рядків.
Це може видатись дрібницею, але використання пробілів і пустих рядків в тексті програми значно покращує її сприйняття (readability - англ., це поняття неможливо перекласти українською одним словом). Спробуйте уявити даний текст без пропусків між словами та абзаців, щоб зрозуміти, як використовувати ці маленькі дрібнички на користь своєї програми. Ми переконані, що вираз
z := x + 2*y – t*(s + 1);
сприймається краще, ніж
z:=x+2*y–t*(s+1);
хоча компілятор в будь-якому разі ігнорує всі пробіли.
Правило: пробіли покращують сприйняття програми її читачеві, отже:
розбивайте текст на логічні фрагменти (абзаци), виділяючи їх порожніми рядками, наприклад, порожній рядок слушно використати після блоку визначення змінних у модулі;
за розділовими знаками, такими як ( . , ) має бути пробіл;
операція – це скорочення слова, отже, вона теж відокремлюється пробілами; виняток складають унарні операції та операції, що мають більш високий пріоритет у виразі (див. приклад, наведений вище).
4. Використання табуляції.
Форматування тексту програми є свого роду коментарем до неї, тому використовуйте акуратні стовпчики там, де це можливо. Наприклад, спробуйте уявити, як виглядав би наступний фрагмент програми без вирівнювання коментарів та ідентифікаторів змінних і констант у вертикальні стовпчики:
Приклад.
const MAX_SIZE = 10; (* розмір масиву *)
var sum : float; (* опишіть зміст sum *)
i, j : integer; (* змінні циклів *)
(* опишіть зміст vect *)
vect : array [1..MAX_SIZE] of real;
Використовуйте відступи також при переносі виразу на наступний рядок, наприклад:
score := 0;
sum := 0.0;
y := sin (x);
sum := sum + x*x + sqrt (y*y + 1) –
exp (1 – 2*log (x*x – x + 2));
5. Мнемоніка ідентифікаторів.
Ідентифікатори (імена змінних, констант, підпрограм, файлів), якщо вони вдало підібрані, можуть замінити або доповнити коментарі в програмі. Отже, при виборі ідентифікаторів будемо керуватись наступними правилами:
ідентифікатори відбивають зміст, отже, використовуйте загально прийняті або зрозумілі абревіатури, наприклад: col та row для індексів стовпчиків і рядків в двовимірному масиві; i,j для змінних циклів; min та max для позначення мінімума та максимума; cur та temp для позначення поточної та робочої змінних;
при виборі імен краще не використовувати схожі ідентифікатори, наприклад: io та i0, а також кирилицю (навіть якщо це дозволяється);
якщо дозволяє мова програмування, використовуйте знак підкреслення, щоб візуально розділити ідентифікатор,