Clean Code – Notatka z nauki

Zanotowałem z tego materiału:

• Produktywność z czasem życia projektu zazwyczaj znacząco maleje.
• Generowanie bałaganu w projekcie i problemów zmniejszających produktywność jest odpowiedzialnością wszystkich, a przede wszystkim inżynierów.
• Czytelność kodu, dobre nazwy, krótkie metody i klasy, przejrzystość – to wszystko oszczędza czas programisty, który próbuje zrozumieć dany fragment kodu.
• Nie używaj magicznych liczb i stringów.
• Poświęć trochę czasu na znalezienie dobrej nazwy.
• Szukaj kontekstów i mechanizmów.
• Używaj wzorców i rozwiązań zwiększających czytelność, np. fluent constructor.
• Jeżeli Twoja firma robi wolno oprogramowanie, to bardzo możliwe, że za chwilę zostanie pokonana przez konkurencję.
• Pamiętaj o SOLID.
• Ciągle refaktoryzuj.
• Czytaj kod i regularnie poprawiaj.
• Nie dawaj wielu argumentów w funkcjach (maksymalnie 3).
• Preferuj wyjątki – miej happy path, a dla wszystkich innych rzucaj wyjątki, aby unikać if-else. Nie zwracaj wielu kodów.
• Zwracaj opcjonalny obiekt, a nie null.
• Nie pisz komentarzy, ponieważ się dezaktualizują. Nikt ich nie poprawia.
• Usuwaj zakomentowany kod.
• Zasada skauta – zostawiaj miejsce czystszym, niż było.
• Pisz komentarz, gdy jest bardzo trudny kod, którego nie da się uprościć. W komentarzu nie pisz, co robi kod, tylko jaką miałeś intencję.
• Komentarze pisz na rzecz dokumentacji, np. Javadocs.
• Unikaj komentowania w innych przypadkach, pisz czytelny kod.
• Testy pozwalają bezpiecznie refaktoryzować.
• Ustal jeden standard pracy w całym zespole (analizery, style, formatowanie).