Clean code (czysty kod) to podejście do pisania programów, w którym priorytetem jest czytelność, prostota i łatwość zmian. Kod jest czytany znacznie częściej niż pisany, więc inwestycja w jego jakość się zwraca.
Podstawowe zasady
- opisowe nazwy zmiennych i funkcji,
- krótkie funkcje o jednej odpowiedzialności,
- brak powielania kodu (DRY),
- komentarze wyjaśniają „dlaczego”, a nie „co”,
- testy zabezpieczające zachowanie przy zmianach.
Jak zacząć stosować te zasady?
Najprościej od przeglądów kodu i niewielkich porządków przy okazji każdej zmiany: zmień nazwę niejasnej zmiennej, wydziel zbyt długą funkcję, usuń martwy kod. Ustaw w projekcie lintera i formater, aby styl pilnowały narzędzia, a nie ludzie.
Przykład: przed i po
Funkcja process($d), która waliduje dane, zapisuje je w bazie i wysyła e-mail, jest trudna do odczytania i testowania. Po podziale na validateOrder(), saveOrder() i sendConfirmation() każda część ma jedną odpowiedzialność i opisową nazwę. Czytelność nie oznacza dłuższego kodu, lecz kod, który wyjaśnia swój zamiar bez komentarzy. Podobne reguły opisują zasady KISS i DRY.
Czy clean code spowalnia pracę?
Na początku nieco, ale zmniejsza koszt późniejszych zmian i poprawek. W dłuższej perspektywie przyspiesza zespół.
Zobacz w praktyce
Powiązane pojęcia
Wszystkie hasła z kategorii Programowanie i wzorce projektowe