Clean Code: Защо кодът ви трябва да се чете като литература?
В света на разработката на софтуер има една популярна мисъл: „Пишете кода си така, сякаш човекът, който ще го поддържа след вас, е агресивен психопат, който знае къде живеете.“ Отвъд шегата, истината е още по-прозаична – кодът се чете много по-често, отколкото се пише. Ето защо добрият програмен код не е просто поредица от инструкции за процесора, а средство за комуникация между хора.
Код за машини vs. Код за хора
Всеки може да напише код, който компютърът разбира. Но само добрите програмисти пишат код, който хората разбират. Когато казваме, че кодът трябва да се чете като литература, имаме предвид, че логиката трябва да бъде ясна, имената – описателни, а структурата – предвидима.
Ако се върнете към свой проект отпреди шест месеца и не разбирате какво прави дадена функция, вие не сте написали „сложен“ код – написали сте лош код.
Златните правила на „Литературния код“
1. Имената са всичко
В литературата имената на героите носят значение. В програмирането променливите и функциите са вашите герои.
-
Лошо:
var d = 86400; // време в секунди -
Добре:
const SECONDS_IN_A_DAY = 86400;
Когато името е описателно, коментарите стават излишни. Кодът започва да „разказва“ историята си сам.
2. Функциите като кратки разкази
Една функция трябва да прави едно нещо и да го прави добре. Ако функцията ви е дълга 200 реда и има пет нива на вложеност (if-else), тя не е разказ, а хаотичен роман. Стремете се към кратки, фокусирани функции, които лесно се обхващат с един поглед.
3. Намалете „шума“ (Коментарите)
Парадоксално, но твърде многото коментари често са признак за лош код. Вместо да обяснявате с коментар какво прави един неясен блок от код, по-добре го пренапишете така, че да е ясен от само себе си. Коментарите трябва да обясняват „защо“, а не „как“.
Техническият дълг: Когато „лошата литература“ излиза скъпо
Писането на „мръсен“ код (Spaghetti Code) е като вземането на заем. В началото се движите бързо, но лихвата се натрупва под формата на технически дълг. С времето добавянето на нови функционалности става все по-трудно, бъговете се множат, а екипът губи мотивация, ровейки се в неразбируеми йероглифи.
Как да започнете още днес?
Чистият код не е дестинация, а навик. Ето три стъпки за следващия ви Pull Request:
-
Правилото на скаута: Винаги оставяйте кода малко по-чист, отколкото сте го намерили.
-
Refactoring: Не се страхувайте да променяте структурата, след като логиката вече работи.
-
Code Review: Гледайте на прегледа на кода като на редакторска работа – помогнете на колегата си да направи „разказа“ си по-разбираем.
„Чистият код винаги изглежда така, сякаш е написан от някой, който го е грижа.“ – Robert C. Martin (Uncle Bob)
