Jak pisać czysty kod?

Pisanie czystego kodu to jedna z najważniejszych umiejętności każdego programisty. Jest niezbędny, by przechodzić code review, unikać niepotrzebnych błędów, oszczędzać czas i skutecznie współpracować z innymi programistami. Ale czym właściwie jest czysty kod? Nie możemy się tu powołać na żadną konkretną definicję. Clean code to raczej idea, zbiór dobrych praktyk, które sprawiają, że kod programistyczny nie tylko działa, ale jest też jasny dla innych, łatwy w edycji i przejrzysty. Jak pisać czysty kod? Co zrobić by był on schludny i zrozumiały? Zapraszamy do lektury!

Kurs Jak pisać czysty kod - dobre praktyki programowania

Zacznij pisać czysty i zrozumiały kod i przenieś swoje umiejętności programistyczne na wyższy poziom. Dowiedz się więcej

Stosuj jasne i spójne nazewnictwo

Jednym z podstawowych nawyków, jakie powinien wyrobić sobie każdy programista jest proste, jasne i spójne nazywanie zmiennych, klas, metod, czy plików. Nazwa powinna jasno określać co przechowuje dana zmienna, czy jak działa dana metoda. Stosowanie skrótów, czy pojedynczych znaków jako nazw jest złym nawykiem, który może mocno utrudnić zrozumienie kodu innym, a nawet Tobie, gdy wrócisz do projektu po jakimś czasie. Dobrym zwyczajem jest również stosowanie jednego, wybranego stylu nazewnictwa np. camelCase, w którym słowa pisane są łącznie, a każdy kolejny wyraz (oprócz pierwszego) rozpoczynamy wielką literą.

Wykorzystuj komentarze

Nie chodzi tu o komentowanie każdej linijki kodu. Komentarze powinny być wykorzystywane do poprawy jego czytelności, dlatego pamiętaj żeby ich nie nadużywać. Idealnie byłoby, gdyby Twój kod był na tyle czytelny i zrozumiały, aby w ogóle nie wymagał stosowania komentarzy. Mówimy wtedy o kodzie samodokumentującym się.

Istnieją jednak sytuacje, w których dodanie komentarza jest konieczne, aby ułatwić zrozumienie kodu innemu programiście, albo Tobie w przyszłości. Podejdź do tego tematu z głową i staraj się ograniczyć stosowanie komentarzy, zastępując je czytelnym kodem, z odpowiednim nazewnictwem.

Formatowanie i wcięcia

Chyba nie ma nic gorszego niż źle sformatowany kod. Każda linijka powinna mieć odpowiednie wcięcie w zależności od tego, na jakim poziomie się znajduje. Pamiętaj, aby w swoim kodzie stosować spójne wcięcia i odstępy między wierszami, a nawiasy klamrowe otwierać i zamykać konsekwentnie i w prawidłowy sposób.

Zachowanie odpowiedniego formatowania jest niezbędne do utrzymania przejrzystości i czytelności Twojego kodu. Na szczęście większość popularnych edytorów kodu lub ich wtyczki zrobią to za Ciebie.

Reguły czystego kodu

Powstało wiele reguł przydatnych w pisaniu czystego kodu. Oto kilka najpopularniejszych:

• DRY - Don't Repeat Yourself - zaleca unikania różnego rodzaju powtórek przez programistów. Chodzi tu nie tylko o unikanie powtórzeń tych samych fragmentów kodu w wielu miejscach, ale również czynności, które można automatyzować.
• KISS - Keep It Simple, Stupid - zaleca pisanie kodu najprostszego, jak to możliwe i stosowanie jak najprostszych i jak najbardziej zrozumiałych rozwiązań. Dotyczy to również nazewnictwa klas, czy metod.
• YAGNI - You aren't gonna need it - zaleca unikać pisania fragmentów kodu “na później” lub “na wszelki wypadek”. Dzięki temu unikamy nadmiarowego kodu.
• SOLID - zawiera 5 podstawowych zasad programowania obiektowego.

Pamiętaj, że kod jest jak wizytówka programisty. Spraw, by Twój był przejrzysty i czytelny nie tylko dla Ciebie, ale również dla osób, z którymi współpracujesz. Jeżeli chcesz dowiedzieć się jak pisać czysty kod i poznać dobre praktyki programistyczne, które przyspieszą i ułatwią Twoją pracę, a także pomogą Ci dobrze wypaść na code review, mamy dla Ciebie świetne rozwiązanie - Kurs Jak pisać czysty kod - dobre praktyki programowania.

Co da Ci Kurs Jak pisać czysty kod - dobre praktyki programowania?

• Nauczysz się uniwersalnych technik pisania czystego i zrozumiałego kodu bez względu na język, w którym programujesz.
• Nauczysz się formatować kod w taki sposób, aby osiągnąć maksymalną czytelność.
• Dowiesz się jak przekształcać źle napisany kod w dobry.
• Zobaczysz jak rozsądnie podchodzić do wzorców projektowych.
• Nauczysz się Obsługi błędów bez zaśmiecania logiki kodu

Kurs prowadzi Arkadiusz Wrzos, full-stack developer, który zawodowo zajmuje się tworzeniem aplikacji mobilnych na platformę Android. Czas wolny chętnie spędza z rodziną i zgłębiając wiedzę na temat programowania. Wolne wieczory spędza tworząc inteligentne zabawki dla dzieci.

Kurs Jak pisać czysty kod - dobre praktyki programowania

Zacznij pisać czysty i zrozumiały kod i przenieś swoje umiejętności programistyczne na wyższy poziom. Dowiedz się więcej