Czym jest „czysty kod”?

Chociaż nie możesz użyć mydła i wody na swoim kodzie, możesz zachować swój kod tak czysty, jak każde naczynie czy sztućce.

Termin „czysty kod” może być mylący dla początkujących. Co to znaczy? Oczyścisz samochód, wyczyścisz buty, jak natomiast wyczyścisz swój kod?

Zacznijmy od myślenia o przeciwieństwie „czystego”, czyli „brudny”. Możesz sobie wyobrazić brudny pokój i jestem pewien, że możesz sobie wyobrazić niechlujny kod. Mówiąc o niechlujnym kodzie, mamy na myśli wiele linii kodu zawierających źle nazwane zmienne, wiele klas w tym samym pliku i tak dalej. W taki sam sposób jak trudno jest przejść przez brudny pokój, trudno jest czytać i pracować z nieschludny kodem.

Jakie są zalety czystego kodu?

Istnieje wiele zalet pisania czystego kodu, oto niektóre z najważniejszych:

• Łatwiej zrozumieć pisany program.
• Możesz łatwo wytłumaczyć, co robi Twój kod.
• Będziesz w stanie go zrozumieć, nawet gdy wrócisz do niego po 6 miesiącach.
• Inni programiści będą w stanie go zrozumieć.
• Będzie łatwiejszy w dalszym rozwijaniu.
• Łatwiej będzie go przetestować.

Co zatem możesz zrobić, aby napisać czysty kod?

Oto niektóre z głównych rzeczy, które możesz zrobić, aby pisać czysty kod:

1. Używaj opisowych nazw: Czym są zmienne, klasy i funkcje? Odpowiedzieć na to można na wiele sposobów, ale kiedy naprawdę o tym myślisz, te rzeczy to nic innego jak interfejs między programistą a podstawową logiką aplikacji. Jeśli więc używasz niejasnych i nieopisowych nazw dla zmiennych, klas i funkcji, zasadniczo zaciemniasz logikę aplikacji każdemu programiście, który czyta kod, w tym sobie.
2. Nadaj każdej klasie/funkcji jeden cel: Czysty kod dzieli się na „cząstki atomowe”. Każda funkcja powinna dążyć do zrobienia jednej rzeczy, a każda klasa powinna reprezentować jedną konkretną koncepcję. Jest to oczywiście uproszczenie, ale w razie wątpliwości zawsze coś prostszego jest bardziej przejrzyste (czyste).
3. Usuń niepotrzebny kod: Zwykle praca nad kodem przebiega w sposób następujący: chcemy naprawić lub zoptymalizować fragment kodu, więc go komentujemy i piszemy tuż pod nim nowy – i mimo że nowy działa, przechowujemy stary kod na wszelki wypadek. Z biegiem czasu, gromadzimy całe mnóstwo skomentowanych bloków kodu, które nie są już potrzebne, a nawet zagracają pliki źródłowe.
4. Czytelność > Spryt: Zbyt wielu programistów łączy „czysty kod” ze „sprytnym kodem”, jakby zagęszczanie dziesięciu linii w jedną było w jakiś sposób „czystsze”. Owszem, zajmuje to mniej miejsca na ekranie, ale czy jest rzeczywiście łatwiejsze do zrozumienia? Czasami może. Ale w większości przypadków? Niekoniecznie.
5. Pisz dobre komentarze: Komentarze powinny występować w celu wyjaśnienia dlaczego dany kawałek kodu istnieje, a nie co robi. Jeśli kod jest napisany wystarczająco czytelnie, powinien on sam w sobie wyjaśniać, co robi – komentarz powinien rzucić światło na intencje kryjące się za tym, dlaczego kod został napisany.