Що таке «правильний код» та як його писати

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

Чистопис по-програмістськи

Практика показує, що навіть поганий код може працювати. Але він завжди ускладнюватиме розвиток проекту: велика кількість ресурсів йтиме на те, щоб у ньому розібратися. Уявіть, що дістаєте з шафи гірлянду для новорічної ялинки: якщо минулого року ви подумали наперед і згорнули її акуратно, то залишається лише закріпити її на дереві та ввімкнути. А якщо ви закинули її в шафу абияк, то вона, звичайно, все ще може горіти і блимати, але доведеться попрацювати, щоб її розплутати. Ось і з кодом так само: подбайте про себе, інших розробників та розвиток проекту заздалегідь, пишіть чисто. Чистий код – код, який легко читається, зрозумілий будь-якому розробнику та простий у підтримці. Це поняття було сформульовано американським інженером і програмістом Робертом Мартіном, відомим серед розробників як «Дядько Боб». Докладно концепцію викладено у його книзі «Чистий код: створення, аналіз та рефакторинг», що вийшла 2008 року.

Гарний код з нуля

• Код повинен легко читатись, бути зрозумілим для інших програмістів. Для цього потрібно використовувати описові імена змінних та функцій. Не варто, наприклад, називати їх абракадаброю з латинських літер: назва має відображати суть.
• Код має бути простим. Варто уникати зайвої вкладеності або довгих блоків коду. Наприклад, програмісти-початківці нерідко використовують для вирішення завдань так звані милиці, які ускладнюють код. Так, вони вирішують проблему, але погодьтеся: йти без милиць простіше і швидше, ніж із ними. Ось і з кодом так само: забирайте зайве, не залишайте зрозумілих тільки вам складних фрагментів.
• Код не повинен вимагати великої кількості коментарів. Вони доречні там, де програміст застосовує якийсь оригінальний підхід, який може бути іншим. Але не треба писати так, щоб кожен рядок доводилося супроводжувати поясненнями. Структуру важливо продумувати заздалегідь, і навіть стежити, щоб кожен метод вирішував лише одне завдання. У разі, коли сервісу знадобляться розвиток та доопрацювання, новий функціонал можна буде додати, не ризикуючи «зламати» старий.
• Код має бути ефективним та оптимізованим. Наприклад, при цьому можна використовувати філософський принцип бритви Оккама — не створювати зайвого без потреби, відсікати його. Це допоможе уникнути повторюваного коду, незграбних «милиць», які уповільнюють роботу програми.

Також виділяють три рівні краси коду: естетика, читання, ефективність.

1. Естетика. Якщо ви пишете код не «в стіл», він не повинен виглядати як списана чернетка. Уявіть, що вам потрібно підключитися до чужого проекту, ви відкриваєте текст програми, а там все рясніє коментарями, немає ніякого форматування. Швидше за все, його захочеться одразу закрити, а не розбиратися. Щоб таких проблем не виникало, в IT-командах є стандарти написання коду — зведення правил, що визначає, як має виглядати текст програми.
2. Читання. Припустимо, код оформлений правильно — з відступами, виділеннями кольорів, без «закоментованих» рядків. Але це ще не означає, що його легко прочитати. Не менш важлива логіка в назвах об'єктів, розміри функцій та методів, відсутність великої кількості умов, що виділяють окремі випадки.
3. Ефективність. У коду має бути продумана, вивірена архітектура, строга логіка. Можна порівняти програму з будинком. Якщо у вас немає чіткого плану роботи і ви просто розширюєте будинок, прибудовуючи до нього одну кімнату за іншою, вона не буде гарною, ні безпечною. Тому архітектори заздалегідь продумують, як виглядатиме будівля, які в ній будуть приміщення, як вони пов'язані між собою. Тільки такий підхід дозволяє побудувати надійну та елегантну будівлю. Аналогічно і з написанням програмного коду: він буде справді гарний, тільки якщо ви заздалегідь пропрацюєте структуру та логіку.

Дотримання стандартів із самого початку — найкраще рішення для програміста-початківця. Почніть із документації мови, якою пишете, — там ви знайдете прийняті правила оформлення коду. Так, для Python підказки слід шукати в документі PEP-8, для роботи з JavaScript вивчіть Airbnb JavaScript Style Guide і Google JavaScript Style Guide. Знайти документацію можна для будь-якої мови, просто введіть у рядок пошукової системи його назву та «code style».

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

Навіщо потрібний чистий код

Чистота коду – не проста формальність. Звичка дотримуватись правил програмування та підтримувати порядок у текстах програм має велике практичне значення.