Добавил:
Upload Опубликованный материал нарушает ваши авторские права? Сообщите нам.
Вуз: Предмет: Файл:
Правила хорошого тону.docx
Скачиваний:
2
Добавлен:
01.03.2025
Размер:
48 Кб
Скачать
☆

1. Намагайтеся помістити функцію в екран

Функція - мінімальний логічно скінчений блок програми. Дуже добре, коли вона поміщається в екран. Тоді весь код можна відразу охопити поглядом. У підсумку зрозуміти, що відбувається в функції, стає значно простіше. Для того, щоб текст помістився в екран, він повинен бути обмежений як по ширині, так і по висоті.

Це, звичайно, в ідеалі, але дуже бажано. Якщо розмір функції становить більше двох екранів - це явна ознака того, що її доцільно розділити на кілька частин. Коли починаєш програмувати якусь завдання, часто буває, що немає бажання відволікатися на дрібниці, наприклад, винести в окрему функцію логування і т.п. В результаті кожна функція вихідного коду крім вирішення своїх основних завдань містить ще купу рядків лівій функціональності, якій просто тут не місце. Пам'ятаю на третьому курсі, я оптимізував свій курсач за машинної графіки шляхом видалення чотирьохсот рядків коду, чесне слово!) Це до того, що краще пізно, ніж ніколи) Але розумніше приділити цьому увагу відразу.

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

Перше обмеження треба намагатися дотримуватися завжди. Адже розбити одну довгу позицію на кілька не становить праці. Я дотримуюся обмеження по ширині в 80 символів, чого рекомендую вам. Чому саме 80? Цифра має історію Розмір екрану консолі в текстовому режимі становив 80x25 символів. Таким чином, рядок більшої довжини просто не містилася в екран. У сучасних текстових редакторах при стандартному розмірі дисплея на екран уміщається більше символів, близько 120. Але це занадто багато для тексту програми. По-перше, такий код важко читати, а, по-друге, він не вміститися на лист A4, якщо ви захочете роздрукувати лістинг програми.

Довжина рядка не повинна перевищувати 80 символів. Пам'ятаю ще на першому курсі наш перший викладач по програмуванню ставив нам невизначений питання «Скі-і-і-льки?», і ми як стадо баранів йому «вооосемьдесят»)) Так, цю цифру ми знали добре. З нас вимагали, щоб рядки не перевищували цієї довжини, тобто щоб містилися на екрані монітора. Зазвичай доводиться переносити або виклики функцій з великою кількістю аргументів, або які-небудь складні умови в конструкціях типу if. Але переносити треба обов'язково, так, щоб весь код був видний без прокручування екрана по горизонталі.

2. Використовуйте табуляцію замість пробілів.

Бажано користуватися саме табом, замість пробілів. Це і швидше (табуляція зазвичай відповідає кільком пробілів), і зручніше для редагування, коли потрібно, наприклад, зрушити код вліво. У багатьох середовищах програмування в панелі інструментів є кнопки для зрушення вліво або вправо блоків коду. Достатньо виділити потрібний код і натиснути на відповідний значок.

Обмеження по висоті дотримуватися виходить далеко не завжди. Але це і не так страшно. Головне, прагнути до того, щоб функція не займала більше двох екранів. А якщо таке відбувається, то ставитися до таких функцій з підозрою і побоюванням. Потрібно подивитися, чи не можна виділити деякі логічні елементи в окремі функції. Однак не варто плодити безглузді функції лише для того, щоб скоротити розмір основної.

3. Слідкуйте за правильним числом відступів всередині конструкцій Якщо не стежити за відступами, код стає просто перестає читатися. Я бачив таке: for i = 0 n do to begin if arr[i] = x begin func(i); end end і навіть таке: for i = 0 to n do begin if arr[i] = x begin func(i); end end Можливі тільки два варіанти: for i = 0 n do to begin if arr[i] = x begin func(i); end end або for i = 0 to n do begin if arr[i] = x begin func(i); end end Виберіть для себе один і завжди дотримуйтеся його. Я вибрав перший, мені здається наочніше і простіше для сприйняття. 6. Раставляйте пропуски правильно. 

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

6.1. Відокремлюйте пробілами оператор присвоювання Невірно: X:=10; Правильно: x := 10; 6.2. Відокремлюйте пробілами оператори у виразі Невірно: x := a+b*c; Правильно: x := a + b * c; 6.3. Ставте пробіл після коми і крапки з комою Невірно: F(1,2,3); int F(int x,int y,int z); for (int i = 0;i < 10;i++) Правильно: F(1, 2, 3); int F(int x, int y, int z); for (int i = 0; i < 10; i++) Всі оператори, що входять в складений оператор (нагадую, складений оператор - це все, що між begin і end в мові програмування Паскаль і між { } у мові програмування C) повинні бути перенесені вправо. Нагадую, є така клавіші на клавіатурі, TAB, ось їй і рухайте, не треба ліпити пропуски. Невірно: if ( a < b ) { j = m; i = l; for (k = 0; k < N; k++) { c[k] += (m-l); u[k-j] = 2*j; if ( l > a ) { break; }; }; printf("ooo, yeahhhh!!!!\n"); }; Правильно: if ( a < b ) { j = m; i = l; for (k = 0; k < N; k++) {  c[k] += (m-l);  u[k-j] = 2*j;  if ( l > a ) {  break;  }; }; printf("ooo, yeahhhh!!!!\n"); };