Jak pisać lepszy kod? 12 technik dla programistów – część 1

Nauka programowania może dostarczać satysfakcji i radości z nawet małych sukcesów, ale samo napisanie dobrego programu to już spore wyzwanie.
Jego najgorszą częścią nie jest wcale stworzenie rozwiązań dla określonych problemów, ale… zrozumienie kodu, który napisałeś wcześniej. Musisz wprowadzić niekończącą się listę poprawek tylko dlatego, że potrzebujesz dodać nową funkcję do programu? Wiesz już, w czym rzecz.

Rozgryzanie, „co autor miał na myśli”, kiedy chcesz, żeby kod po prostu działał, potrafi być frustrujące. Rozwiązanie jest proste: wystarczy wprowadzić w życie dwanaście prostych nawyków kodowania, aby pisać kod bardziej przejrzysty i łatwiejszy w zarządzaniu.

1. Pisz kod przyjazny dla dewelopera (i dla siebie)

Wiadomo, że kod ma przede wszystkim działać, ale nie piszesz go tylko dla urządzeń. Pomyśl o tym, jak w przyszłości będziesz na nim pracował. Czy to, co piszesz dzisiaj, będzie dla ciebie czytelne i zrozumiałe również za kilka miesięcy?

Przestrzegaj zasad spójnego nazewnictwa
Jeśli na przykład założysz, że wszystkie prywatne zmienne piszesz małą literą, trzymaj się tego konsekwentnie przez resztę pracy. Za sześć miesięcy możesz nie pamiętać, czy różna pisownia miała coś oznaczać, czy była wynikiem niekonsekwencji.

Jeśli pracujesz w grupie, ustalcie zasady nazewnictwa, zanim ktokolwiek zacznie pracę.

2. Opisowe nazwy zmiennej/metody

Zmienne i metody powinny opisywać, co dokładnie robi ten fragment kodu. Nietypowy skrót, jak Sort_PT(), za jakiś czas może być zupełnie nieczytelny. Zamiast łamać sobie głowę nad tym, o co ci chodziło, zmień nazwę na Sort_PostyType(). Będziesz sobie wdzięczny.

3. Wcięcia i akapity

Jeśli myślisz, że sprawdzają się tylko w książkach, pomyśl jeszcze raz. Wcięcia i akapity pozwalają w prosty i efektywny sposób przedstawić organizację i strukturę twojego kodu. Ułatwi to także późniejsze zrozumienie, jak ma funkcjonować.

Przyjmij także, że stosujesz akapity, kiedy dwa kody w tym samym wierszu wykonują inne rzeczy. Ma to znaczenie szczególnie we właściwościach CSS: lepiej nie łączyć ich wszystkich w jednym łańcuchu na kilka linijek, żeby niepotrzebnie nie komplikować.

4. Organizacja i struktura

Najważniejsze w pisaniu przejrzystego kodu jest zachowanie jasnej struktury i organizacji całości, które poprawią jej czytelność. Grupuj napisany kod, aby ułatwić sobie późniejsze wprowadzanie zmian i modyfikacji.
Musisz przewinąć sporo tekstu, żeby znaleźć sekcję, w której pojawił się błąd? Popracuj nad strukturą.

Nie wrzucaj całego kodu w jeden skrypt. Może plik, w którym masz zapisane kilka tysięcy linijek kodu, wygląda super, ale debugowanie czegoś takiego to koszmar w czystej postaci. Dlatego właśnie twoim podstawowym celem powinno być organizowanie kodu tak, aby łatwo było wprowadzać poprawki.
Dziel zapisany kod na oddzielne pliki, w zależności od ich funkcji.

Jeśli tylko jest to możliwe, upewnij się, że język spełnia podstawowy cel. Jeśli piszesz efekty animacji w CSS3, unikaj wprowadzania dodatkowo animacji w jQuery – chyba że naprawdę nie masz innego wyboru. Jeśli już to robisz, dodaj komentarz w pliku CSS o wyjątku.

5. Planowanie

Paradoksalnie w programowaniu najważniejsze jest planowanie – i to zanim jeszcze napiszesz pierwszą linijkę. Napisanie nawigacji nie powinno być dla ciebie wyzwaniem, ale co jeśli menu ma być responsywne, a jednocześnie zmniejszać się, kiedy użytkownik przesunie stronę w dół?

Jeśli nie określisz funkcji, jakie ma spełniać kod oraz nie zaplanujesz pracy, zanim ją zaczniesz, zwiększasz ilość późniejszych zmian, poprawek, przeróbek i opóźnień. To najprostsza droga do frustracji i niezadowolenia z pracy, a przecież nie o to chodzi, prawda?
Łatwiej jest najpierw zdefiniować problem, a dopiero potem stworzyć rozwiązanie.

6. Zarządzanie

Nie chcesz edytować dziesiątek zmiennych linijka po linijce – chyba że twoim celem jest ćwiczenie w pokorze i wytrwałości. Zamiast tego możesz po prostu pisać kod, który wymaga tak niewielu ręcznych zmian, jak to tylko możliwe.

Jak to zrobić? Używaj tablic array. Tablice sprawdzają się przy przechowywaniu wielu zmiennych danego typu, do których masz dostęp za pomocą wygodnych pętli for i for each.
Istnieje też sporo innych, dynamicznych metod, które polegają na dodawaniu, porządkowaniu i poprawianiu danych w konkretnych językach, na przykład List i LINQ w C#. Sprawdzaj, czy nie pojawiły się nowe dodatki, biblioteki lub wtyczki dla sprawniejszego zarządzania danymi.

Wreszcie, aby uniknąć niekończących się zmian w kodzie, pisz kod jak najbardziej niezależny, który nie rozbije całego systemu, kiedy trzeba będzie wprowadzić nowe zmiany lub funkcje. Po optymalizacji deweloper potrzebuje tylko dopracować kod w jednej klasie zamiast w trzech. Taki system nazywany jest Loose Coulpling.

Jak pisać lepszy kod? 12 technik dla programistów – podsumowanie

Nawet jako początkujący programista zauważyłeś na pewno, że napisanie prostego programu potrafi przeciągnąć się w czasie, a sam projekt rozrosnąć się do rozmiarów, o które go nie podejrzewałeś.

Oznacza to, że kilka dni, tygodni lub miesięcy później musisz wrócić do wcześniej napisanego kodu i… jeśli musisz zgadywać, o co ci chodziło, najwyraźniej czas poprawić swoją technikę.

Dobry kod oprócz tego, że działa, powinien być także czytelny, przejrzysty i łatwy do zarządzania, również po upływie jakiegoś czasu. Ma to znaczenie nie tylko, kiedy pracujesz w grupie, ale również przy samodzielnych projektach.
Czas, który zainwestujesz w wypracowanie sobie pewnych nawyków to czas, który zaoszczędzisz na poprawkach, wprowadzaniu zmian i debugowaniu. Na drugą część zestawu naszych rad zapraszamy już za tydzień!