Czysty kod można określić stylem programowania, który jest skoncentrowany na czytelniku. Chodzi tutaj o tworzenie oprogramowania, które nie tylko łatwo napiszemy, ale będzie to taki kod, który ktoś później łatwo zrozumie i będzie mógł przeprowadzić ewentualne zmiany.
Wielu programistów, zwłaszcza początkujących, decyduje się na taki kod, który jest zgodny z oczekiwaniami użytkownika końcowego. Inaczej mówiąc, kiedy dana aplikacja działa poprawnie, uznają, że ich praca jest ukończona. Nie powinniśmy jednak pisać kodu tylko do wykorzystywania przez komputery – ten powinien być również łatwy w zrozumieniu dla innych programistów.
Zobacz: Serverless computing
Czysty kod cechuje się tym, że jest adresowany nie tylko do komputerów, ale też do ludzi. Jeśli ktoś przygotowuje kod zgodnie z zasadami „czystości”, napisze go w taki sposób, że będzie on wysoce modułowy, a przez to łatwiejszy do odczytania, testowania i wprowadzania zmian.
Czysty kod, czyli pisz tak, aby inni zrozumieli
Pisanie kodu, jeśli już potrafimy programować, jest stosunkowo łatwe. To czytanie i zrozumienie tego, co napisał inny programista, często sprawia problem. Wielu specjalistów nawet decyduje się na przepisywanie poszczególnych funkcji, niż przeczytanie i zrozumienie czyjegoś kodu, by kolejno wprowadzić pożądane zmiany.
Podajemy 5 polecanych metod i zasad, które pozwolą na pisanie czystego, albo przynajmniej bardziej czystego kodu:
1. Czysty kod to porządek
Funkcje powinny robić jedną – i tylko jedną rzecz. W czasie programowania, gdy utworzymy daną funkcję, oceńmy czy jest ona możliwie wyodrębniona z innych funkcji i całego projektu. Jeśli to możliwe, starajmy się pisać kod w taki sposób, aby tworzyć poszczególne moduły – tak, by w razie potrzeby można było je łatwo i szybko wyodrębnić z całości. Konkretna funkcja powinna więc robić tylko jedną, konkretną rzecz. I nic więcej.
Kiedy mamy pewność, że dana funkcja wykonuje tylko jedną rzecz, zadbajmy o to, aby była zwięźle napisana. Wielu programistów uważa, że 10 linijek kodu lub mniej to dobry standard. Jeśli nasz kod jest o wiele dłuższy, może to być znak, że powinniśmy go podzielić na dwie lub więcej krótszych funkcji.
2. Komentarze? Dobrze, ale nie przesadzaj
Jeśli kod jest dobrze napisany i ma praktyczne nazewnictwo, często komentarze możemy zachować dla siebie. Naprawdę zrozumiały kod jest „samoopisujący się” – dobry programista szybko zrozumie o co chodzi, gdy zobaczy kod i komentarze nie są mu potrzebne.
Zanim dodamy komentarz do własnego kodu, warto najpierw zastanowić się nad tym, czy jest to naprawdę konieczne. Być może lepiej popracować nad samym kodem – w taki sposób, aby był bardziej zrozumiały dla innych specjalistów?
Jednocześnie pamiętajmy, że w kodzie można dodawać komentarze i często jest to wskazane. Zadbajmy jednak o to, aby komentarze były faktycznie uzasadnione i naprawdę potrzebne.
3. Zachowaj ten sam styl – wszędzie
Programista powinien być konsekwentny – spójność ma duże znaczenie dla czystego kodu. Jeśli tworzymy oprogramowanie, warto trzymać się określonych zasad. Zwłaszcza jeśli wiemy, że później inne osoby będą nad nim pracować.
Sprawdź: Debugowanie
Tutaj warto podejść do pisania kodu jak do pisania tekstów. Jeśli przykładowo stosujemy skrót „proc.” zamiast „%”, to nie piszmy na początku 10%, by w kolejnym zdaniu używać już 10 proc. Albo nie stosujmy „USD”, jeśli za chwilę chcemy napisać „dolarów”. Takie same zasady dotyczą pisania kodu.
4. Jeśli nazwy, to takie, które faktycznie istnieją
Nazewnictwo to ważna część czystego kodu. Sprawia, że jest on zrozumiały dla każdego, a nie tylko dla jego twórcy. Używajmy nazw, które można wymówić.
Przykład podaje Robert C. Martin, autor książki „Clean Code: A Handbook of Agile Software Craftsmanship”:
Nie rób tak:
let psbs;
Rób za to tak:
let publicSubscribers;
Czysty kod ma w sobie funkcje, które są czasownikami lub frazami czasownikowymi, a nie rzeczownikami. Klasy i nazwy obiektów są z kolei rzeczownikami, a same nazwy zawsze powinny mieć jakieś znaczenie – tak, aby inny specjalista mógł zrozumieć znaczenie treści, po prostu czytając dane fragmenty.
5. Kończymy wtedy, gdy inni to rozumieją – a nie tylko my i komputer
Nie powinniśmy uważać pracy za ukończoną tylko dlatego, bo funkcja działa poprawnie po stronie użytkownika. Czysty kod to taki, który jest zrozumiały dla wszystkich. Dlatego po napisaniu funkcji w taki sposób, aby po prostu działała poprawnie, powinniśmy poświęcić czas na proces oczyszczania.
Sprawdź: Pokolenie X
Wprowadzamy wtedy poszczególne zmiany, pracując nad spójnością i zwięzłością. Im mniej znaków, tym lepiej – jeśli oczywiście zachowamy tę samą funkcjonalność.
IT-Leaders.pl to pierwsza w Polsce platforma łącząca Specjalistów IT bezpośrednio z pracodawcami. Anonimowy, techniczny profil i konkretnie określone oczekiwania finansowe to tylko niektóre z cech wyróżniających platformę. Zarejestruj się i zobacz jak Cię widzi pracodawca.