Zasady czystego kodu – jak pisać lepszy kod?
W świecie programowania jakość kodu ma ogromne znaczenie. Niezależnie od używanego języka, dobrze napisany kod powinien być czytelny, łatwy do utrzymania i zrozumiały dla innych programistów. Właśnie dlatego warto stosować zasady czystego kodu (Clean Code), które pomagają w tworzeniu lepszych aplikacji i minimalizują ryzyko błędów.
W tym artykule omówimy kluczowe zasady czystego kodu oraz podpowiemy, jak stosować je w praktyce.
1. Co to jest czysty kod?
Termin „czysty kod” został spopularyzowany przez Roberta C. Martina, znanego jako „Uncle Bob”, w książce Clean Code: A Handbook of Agile Software Craftsmanship. Czysty kod to taki, który:
✅ Jest łatwy do zrozumienia.
✅ Jest prosty do utrzymania i rozbudowy.
✅ Jest dobrze zorganizowany i spójny.
✅ Jest zoptymalizowany, ale nie nadmiernie skomplikowany.
Czysty kod nie jest sztuką dla sztuki – jego głównym celem jest ułatwienie pracy zarówno autorowi, jak i innym programistom, którzy będą z niego korzystać.
2. Zasady czystego kodu
2.1. Czytelność ponad wszystko
Kod powinien być tak napisany, aby był zrozumiały bez konieczności analizowania jego logiki.
❌ Zły przykład:
def fn(a, b):
return a * b / 100
✅ Dobry przykład:
def calculate_discount(price, discount_percentage):
return price * discount_percentage / 100
Dzięki używaniu czytelnych nazw zmiennych i funkcji od razu wiadomo, co robi kod.
2.2. Dobre nazwy zmiennych, funkcji i klas
Nazwy powinny jasno określać cel danej zmiennej, funkcji czy klasy.
✅ Najlepsze praktyki:
- Zmienna powinna mówić, co przechowuje:
current_user,order_total,email_list. - Funkcja powinna zawierać czasownik i jasno określać działanie:
send_email(),calculate_salary(),validate_input(). - Klasy powinny być rzeczownikami:
User,Invoice,DatabaseConnector.
❌ Zły przykład:
int x = 10;
String y = "Jan";
✅ Dobry przykład:
int maxRetries = 10;
String userName = "Jan";
2.3. Jedna funkcja powinna wykonywać jedno zadanie
Funkcja powinna robić tylko jedną rzecz i robić to dobrze.
❌ Zły przykład:
def process_order(order):
validate_order(order)
save_to_database(order)
send_email(order)
✅ Dobry przykład:
def validate_order(order):
# Walidacja zamówienia
pass
def save_order_to_database(order):
# Zapis do bazy danych
pass
def send_order_confirmation_email(order):
# Wysyłka maila
pass
Każda funkcja wykonuje jedno konkretne zadanie, co ułatwia jej ponowne wykorzystanie i testowanie.
2.4. Unikaj zbędnych komentarzy – kod powinien być samoopisujący się
Dobrze napisany kod nie wymaga nadmiarowych komentarzy.
❌ Zły przykład:
// Funkcja dodaje dwie liczby i zwraca wynik
public int add(int a, int b) {
return a + b;
}
✅ Dobry przykład:
public int sumTwoNumbers(int firstNumber, int secondNumber) {
return firstNumber + secondNumber;
}
Jeśli nazwy funkcji i zmiennych są dobre, niepotrzebne są dodatkowe komentarze.
2.5. Unikaj powtarzania kodu (DRY – Don’t Repeat Yourself)
Powtarzający się kod prowadzi do błędów i utrudnia utrzymanie.
❌ Zły przykład:
total_price = item_price * quantity
tax = total_price * 0.2
final_price = total_price + tax
order_price = order_price * order_quantity
order_tax = order_price * 0.2
order_final = order_price + order_tax
✅ Dobry przykład:
def calculate_total_price(price, quantity, tax_rate=0.2):
total = price * quantity
tax = total * tax_rate
return total + tax
Dzięki temu można wielokrotnie używać tej samej funkcji, zamiast kopiować kod.
2.6. Unikaj długich funkcji
Długie funkcje są trudne do zrozumienia i testowania. Optymalnie powinny mieć maksymalnie 20-30 linijek.
2.7. Trzymaj się jednolitego formatowania kodu
Kod powinien być spójny w całym projekcie – jednolite wcięcia, odstępy, sposób deklarowania zmiennych.
✅ Używaj narzędzi do automatycznego formatowania kodu, np.:
- Prettier (JavaScript, TypeScript)
- Black (Python)
- ESLint (JavaScript)
2.8. Obsługuj błędy i wyjątki
Dobrze napisany kod powinien przewidywać możliwe błędy.
❌ Zły przykład:
def get_price(item):
return item["price"]
Jeśli item nie zawiera klucza "price", funkcja zwróci błąd.
✅ Dobry przykład:
def get_price(item):
try:
return item["price"]
except KeyError:
return 0 # Domyślna wartość, jeśli brak klucza
2.9. Regularnie refaktoryzuj kod
Kod powinien być stale poprawiany i optymalizowany. Regularna refaktoryzacja zmniejsza dług technologiczny i sprawia, że projekt jest łatwiejszy do rozwijania.
2.10. Pisz testy jednostkowe
Testy pozwalają na wczesne wykrywanie błędów i zapewniają, że kod działa poprawnie po zmianach.
✅ Popularne narzędzia do testów:
- Jest (JavaScript)
- Pytest (Python)
- JUnit (Java)
Podsumowanie
Zasady czystego kodu pomagają w pisaniu przejrzystych, łatwych do utrzymania i efektywnych aplikacji. Kluczowe elementy to:
✔️ Czytelność – dobre nazwy i czytelny format kodu.
✔️ Modularność – każda funkcja powinna robić jedno zadanie.
✔️ Brak zbędnych powtórzeń – stosowanie zasady DRY.
✔️ Dbałość o obsługę błędów.
✔️ Testowanie kodu – unikanie błędów dzięki testom jednostkowym.
Dzięki stosowaniu tych zasad Twoje programy będą bardziej przejrzyste, łatwiejsze do rozwijania i mniej podatne na błędy.
Rozwój aplikacji w języku Python (Django, Flask): Tworzenie aplikacji webowych i API Python to jeden z najpopularniejszych języków programowania na Czytaj dalej
Jakie są trendy w programowaniu front-end i back-end w 2024 roku? Świat programowania zmienia się dynamicznie, a technologie, które były Czytaj dalej
