Apostolstwo Dobrego Kodu

Czysty kod

Zanim można będzie odpowiedzieć na zadane pytanie, należy wyjaśnić, czym jest czysty kod? Określenie to nie posiada jasno sprecyzowanej definicji. Jest to pewna idea, praktyka, według której kod powinien być łatwy w edycji i zrozumiały. Ale powiedzieć tylko tyle to jakby nie powiedzieć nic. Nasuwa się bowiem kolejne pytanie - co to znaczy, że kod jest zrozumiały?

Jak zrozumieć kod?

Prawda jest taka, że kod strony czy programu pisany jest nie dla klienta, lecz dla kolejnych deweloperów i programistów, którzy będą z niego korzystali. Bez odpowiedniego doświadczenia i znajomości języka, w którym jest napisany, nawet najlepszy kod może być niezrozumiały. Ale nie musi! Najważniejszą zasadą czystego kodu jest to, by był on czytelny oraz samokomentujący się. Bogatym źródłem wiedzy o poprawnym i przyjemnym w późniejszej pracy kodzie jest książka Roberta C. Martina pod tytułem "Czysty kod. Podręcznik dobrego programisty". Na jej podstawie można sformułować pewne zalecenia, których stosowanie umożliwi wytworzenie czystego kodu.

Oceniaj kod po okładce

Najprostszym sposobem oceny kodu przez niemal każdego jest ocena jego formatowania. Warto zaznaczyć, że ocenie podlega wyłącznie kod niezminifikowany i nieskompilowany czyli taki, który służy pracom, a nie taki, który docelowo trafi na stronę czy do programu. Do najważniejszych zasad, które powienien spełniać każdy kod należą:

• małe pliki/klasy są lepsze niż duże
• odstępy między segmentami kodu
• kolejność metod i funkcji powinna być usegregowana wg rosnącej szczegółowości
• wiersze maksymalnie 120-znakowe
• spacje wokół operatorów
• wcięcia poziome oddzielające bloki kodu
• spójne formatowanie w całym zespole

Tych kilka punktów potrafi niesamowicie ułatwić pracę i podnieść czytelność kodu. Stosowanie się do tych zasad odróżnia programistę od dobrego, eleganckiego programisty. Czysty kod powinien być elegancki.

A imię jego czterdziesci_i_cztery

Niezwykle istotne jest, aby kod był samokomentujący się. Co to oznacza? Powinien stosować takie nazwy klas, metod i funkcji, z których można wyczytać czego one dotyczą. W związku z tym, nazwy te powinny jednoznacznie przedstawiać intencję, unikać dezinformacji, a dodatkowo powinny być łatwowymawialne oraz łatwe do wyszukania. Oprócz tego, format nazwy powinny być adekwatny do używanego języka. Istnieje wiele różnych systemów notacji, na przykład:

• camelCase, w którym wyrazy pisany są łącznie i z wielkiej litery oprócz pierwszego, np: dlugaNazwaZmiennej - stosowany jest najczęściej w różnych językach programowania(np. Java, C++) do nazywania funkcji i metod
• snake_case, w którym wyrazy pisane są rozłącznie z małych liter, a odstępy między nimi stanowi znak "_" - stosowany jest najczęściej w języku programowania Pascal

Najważniejsze aby format nazwy był spójny dla całego zespołu. W takim wypadku warto przyjąć wspólną konwencję nazewniczą. Jest to pewien zestaw instrukcji, który określa w jaki sposób powinny być nazywane kolejne elementy kodu. Jako przykład może służyć zyskująca na popularności konwencja BEM, czyli Blok - Element - Modyfikator. Wymyślona na potrzeby języka CSS zdecydowanie sprawdza się w codziennej pracy.

Czyściej znaczy lepiej

Łatwo można się domyśleć, że czysty kod potrafi znacznie przyspieszyć pracę każdej kolejnej osoby zaangażowanej w projekt. Rozwijanie takiego kodu i jego modyfikacje stają się o wiele prostsze. Oszczędza to czas, a więc i pieniądze. Jeżeli zatrudniona firma przestrzega zasad czystego kodu, możemy być pewni, że nawet po zakończeniu współpracy, kolejni programiści i deweloperzy nie powinni mieć problemu wdrożyć się w nasz projekt.

Ocena kodu potrafi być trudna, warto więc zlecić takie zadanie specjalistom. Zamawiając audyt warto zapytać się o ocenę czystości kodu, bo clean code to podstawa!