Przejdź do głównej zawartości
Codex13

67. Clean Code w PHP — zasady Roberta Martina w praktyce

O czym jest to opracowanie?

Dział zatytułowany „O czym jest to opracowanie?”

Clean Code w PHP

Clean Code to zbiór zasad pisania kodu, który jest czytelny, zrozumiały i łatwy do modyfikacji. Robert C. Martin w swojej książce „Clean Code” (2008) sformułował reguły dla nazewnictwa, funkcji, komentarzy i struktury kodu. Dobry kod czyta się jak dobrze napisaną prozę.

Dlaczego warto to znać?

Dział zatytułowany „Dlaczego warto to znać?”
  • Kod czytany jest 10x częściej niż pisany — czytelność ma cenę
  • Code review w firmach ocenia jakość kodu, nie tylko jego działanie
  • Utrzymywanie brudnego kodu kosztuje wielokrotnie więcej niż jego pisanie

Cel Twojego opracowania

Dział zatytułowany „Cel Twojego opracowania”
  1. Wyjaśnić czym jest Clean Code i dlaczego jest ważny
  2. Opisać zasady nazewnictwa zmiennych, funkcji i klas
  3. Omówić zasady dotyczące funkcji (jedna odpowiedzialność, argumenty)
  4. Pokazać przykłady złego i dobrego kodu PHP

Zakres obowiązkowy

Dział zatytułowany „Zakres obowiązkowy”
  1. Definicja Clean Code — kod jak proza
  2. Nazewnictwo: zmienne, funkcje, klasy — opisowe a nie skrótowe
  3. Funkcje: jeden cel, max 3 argumenty, brak efektów ubocznych
  4. Komentarze: kiedy pisać, kiedy NIE pisać (kod się sam dokumentuje)
  5. Formatowanie: wcięcia, długość linii, grupy logiczne
  6. Zasada DRY (Don’t Repeat Yourself)
  7. Zasada KISS (Keep It Simple, Stupid)

Wymagane przykłady kodu

Dział zatytułowany „Wymagane przykłady kodu”

Przykład 1

Funkcja z złym vs dobrym nazewnictwem

Przykład 2

Funkcja robiąca za dużo vs podzielona na mniejsze

Przykład 3

Przykład naruszenia DRY i refaktoryzacja

Proponowana struktura pracy

Dział zatytułowany „Proponowana struktura pracy”
  1. Wstęp — koszt złego kodu
  2. Nazewnictwo zmiennych i funkcji
  3. Zasady dotyczące funkcji
  4. Komentarze — kiedy i kiedy nie
  5. Formatowanie i struktura
  6. DRY i KISS
  7. Przykłady refaktoryzacji
  8. Podsumowanie i bibliografia

Pytania kontrolne

Dział zatytułowany „Pytania kontrolne”

Najczęstsze błędy

Dział zatytułowany „Najczęstsze błędy”

Zasoby

Dział zatytułowany „Zasoby”
Clean Code — Robert C. Martin Książka Clean Code
PHP Clean Code — GitHub Clean Code w PHP — przykłady
PHPStan Statyczna analiza kodu PHP

Do dzieła!

Dział zatytułowany „Do dzieła!”

Zrefaktoruj jeden plik ze swojego projektu!

Weź najdłuższy plik PHP z projektu i zastosuj zasady Clean Code. Porównaj wersję przed i po — to gotowe opracowanie z własnym przykładem.