Czysty kod

Wejście w świat programowania wiąże się z koniecznością poznania wielu nowych technik a także konwencji. Są to między innymi algorytmy, struktury danych czy konkretne elementy specyficzne dla danego języka programowania. W ogromie wiedzy niezbędnej do przyswojenia niekiedy zapomnieć można o innych, czasami mniej sformalizowanych, zasadach obowiązujących dobrego programistę. Jedną z takich zasad, mówiąc dokładniej zbiorem zasad jest coś, co potocznie nazywane jest czystym kodem.

Zasad czystego kodu jest wiele i mogą być one zależne od języka programowania a nawet od konkretnego programisty. Istnieje jednak kilka uniwersalnych zasad, które warto stosować niezależnie od języka programowania oraz środowiska, w którym się poruszamy:

1) Wcięcia

W większości języków programowania, choć nie wszystkich, wcięcia kodu nie są elementem niezbędnym do poprawnego działania kodu. Ciężko jednak wyobrazić sobie profesjonalny i czytelny kod, który jest ich pozbawionych. Poprawne używanie wcięć pozwala na szybką identyfikację poszczególnych bloków kodu, niezależnie od tego, czy chodzi o style w CSS, czy ciało funkcji w JavaScript. Najlepszym sposobem na tworzenie wcięć jest używanie klawisza Tab. Dzięki temu istnieje 100 procent pewności, że każde pojedyncze wcięcie w kodzie składać będzie się z identycznej liczby spacji. Może wydawać się to mało istotne, ale w przypadku nawet niewielkiego projektu robi dużą różnicę na plus.

2) Konwencje nazewnicze

Każdy programista wykorzystuje w swoim kodzie pewne konwencje nazewnicze. Często wynikają one z jego osobistych przyzwyczajeń, kiedy indziej są narzucane lub wybrane przez cały zespół, który współtworzy kod. W przypadku korzystania z danych konwencji nazewniczych ważna jest przede wszystkim jedna rzecz: spójność ich wykorzystania. Wystarczy wyobrazić sobie pewną sytuację: dwóch programistów pisze kod w języku JavaScript. Jeden z nich konsekwentnie nazywa elementy swojego kodu w ten sam sposób na przykład isHuman, saveRate czy carModel. Drugi z hipotetycznych programistów nie przywiązuje żadnej wagi do tego, w jaki sposób nazywa elementy swojego kodu. W związku z tym jego kod wypełniony jest nazwami takimi jak isHuman, save_rate czy car_Model.
Z jednej strony kod zarówno pierwszego, jak i drugiego programisty może poprawnie się wykonać. Z drugiej strony, jeśli pomyślimy, że kod obu programistów liczy po kilkaset linijek to łatwo sobie wyobrazić zapis, którego z programistów będzie łatwiej odczytać czy zrozumieć. Oczywiście, trzymanie się danej konwencji nazewniczej nie dotyczy tylko opisanego w przykładzie JavaScriptu. Może być to na przykład chociażby sposób nazywania klas w CSS.

3) Komentarze

Należy pamiętać, że komentarze nie służą tylko do ominięcia danego fragmentu kodu. Są one również potężnym narzędziem pozwalającym na dokładny opis kodu. Jasną sprawą jest, że nie należy dodawać komentarza do każdej, nawet najbardziej trywialnej linijki swojego kodu. Komentarze powinny służyć do opisu większych fragmentów kodu, czyli na przykład wskazywać na to, jak działa dana funkcja. Ma to bardzo duże znaczenie w przypadku kiedy kod dotyczy specjalistycznej dziedziny, która nie jest każdemu znana. Nie każdy przecież musi wiedzieć do czego służy transformacja Fouriera czy Laplace’a. Jednak dzięki odpowiednim komentarzom, przeznaczenie nawet najbardziej zawiłych fragmentów kodu staje się oczywiste.

Podsumowując, należy pamiętać, że często wersja którą aktualnie tworzymy jest dopiero początkiem jego życia a jego dalszy rozwój może trwać przez miesiące czy nawet lata. Dbając od początku o jego czystość sprawiamy, że nawet po długim czasie, praca z danym oprogramowaniem jest dużo prostsza i przyjemniejsza.