Ostatnia aktualizacja 11 marca, 2022
Pisanie kodu to zwykle wyścig z deadline’ami z myślą o tym, aby stworzyć jak najlepszy kod, który działa. W praktyce może się okazać, że struktura kodu jest mało czytelna, a pośpiech nie sprzyja optymalizacji. Efektem takiej sytuacji jest frustracja wynikająca z marnowania czasu na zrozumienie zawiłych struktur. Jak pisać czysty kod, który pozwoli uniknąć takich problemów?
Sprawdź: Branża IT
Czym jest czysty kod?
Choć nie ma jednej definicji, intuicja podpowiada kilka oczywistych cech, wśród których najważniejszymi są:
- łatwość zrozumienia,
- łatwość edycji,
- możliwie jak największa prostota.
Poddawanie kodu ciągłym, regularnym testom umożliwia zachowanie powyższych cech. Nie da się stworzyć kodu idealnego, ale możliwe jest napisanie najlepszego kodu w danych okolicznościach. Jakich zasad należy się trzymać, aby uzyskać czysty kod podczas programowania?
Zobacz: Systemy rozproszone
8 zasad czystego kodu
1. Spójność nazw zmiennych – aby zachować dobry poziom czytelności konieczne jest spójne nadawanie nazw zmiennym. Dobre nazewnictwo zwiększy poziom orientacji w kodzie dzięki uwzględnieniu funkcji informacyjnej.
2. Brak duplikowania fragmentów – programista powinien kierować się zasadą DRY (Don’t Repeat Yourself), czyli dążyć do redukcji powtórzeń tam, gdzie jest to możliwe.
3. Dbałość o formatowanie – dobrze sformatowana struktura to klucz do czytelności, dlatego warto poświęcić czas na zachowanie spójności w formatowaniu. Pozwoli to później szybko odnajdować wybrane fragmenty kodu.
4. Unikanie komentarzy – potrzeba komentarzy wynika z niejasności i braku spójności. Zachowując zasady dotyczące odpowiedniego nazewnictwa klas i metod oraz pilnując formatowania, programista nie będzie musiał dodatkowo komentować elementów.
5. Odpowiednia wielkość klas i metod – zbyt duże klasy i metody wprowadzają chaos, cechując się zbyt dużą liczbą linijek kodu i zależności.
6. Hermetyzacja – funkcje użytkowe w klasach powinny być prywatne, aby sprawnie i bezpiecznie przeprowadzać refaktoryzację.
7. Polecenia i zapytania powinny być oddzielne – łączenie operacji może prowadzić do błędów. Aby nie występowały niejasności należy tworzyć osobne funkcje dla poleceń i zapytań zgodnie z zasadą pojedynczej odpowiedzialności.
8. Ciągła praktyka i doskonalenie – czysty kod jest efektem wielu godzin spędzonych na praktyce. Nie da się dojść do tego na skróty. Ważne jest, aby doskonalić umiejętności i szukać optymalnych rozwiązań, które mogą już istnieć dla napotkanych problemów.
