Правила та стандарти оформлення коду програм - робимо код красивим!

Правила та умови

На форумі заборонено:

Порушники правил будуть суворо покарані модераторами або адміністратором форуму і їм буде повністю закритий доступ на форум.

Використовуючи цей форум Ви можете:

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

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

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

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

Думаю, ви помітили, який з них краще виглядає. Одним словом, за стандартом після ком повинен бути пробіл, між логічними і арифметичними блоками також.

5. Цей пункт буде великим і важливим. Тут ми розглянемо іменування об'єктів програми (змінних, функцій, класів, методів і т.д.).

стиль іменування

Всі об'єкти програми повинні бути названі обгрунтованими іменами, що говорять про призначення того чи іншого об'єкта.

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

Константи рекомендується писати в верхньому регістрі.

Для іменування змінних потрібно використовувати іменники, а для іменування функцій дієслова (або дієслово + іменник), тому що це дія. приклад функцій

При іменуванні методів класів і функцій, які повинні щось повертати, використовують префікс get (отримати). Для тих, які встановлюють, використовують set (встановити)

верблюжа нотація

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

Угорська нотація

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