Dobre praktyki programistyczne cz. 2 – nazewnictwo

Ile razy czytaliśmy kod napisany przez kogoś innego i próbowaliśmy przez cały dzień zrozumieć, co autor miał na myśli? Każdy programista chyba raz w życiu miał taką sytuację. Odpowiednie nazywanie funkcji, zmiennych czy klas ma bardzo ważne znaczenie i jest niezależne od języka programistycznego, w którym piszemy. Robert C. Martin w swojej książce  Czysty kod przedstawia zalecane metody nazywania elementów kodu.
Nazwy powinny jasno określać intencję. Nazwy zmiennych, metod czy klas powinny odpowiadać na wszystkie pytania, być jasne dla programisty, który będzie czytał nasz kod. Nie powinny to być skróty, jednak zmienna o nazwie carMarkInGarageToRepairTodayByMechanic również nie jest poprawna. Zmienne „x”,”y”,”z” powinno się używać tylko w szczególnych wypadkach.

Klasy i obiekty
Klasy i obiekty powinny być rzeczownikami lub wyrażeniami rzeczownikowymi. Dlaczego? Klasa, jak wiemy, generuje obiekty, które w luźnym znaczeniu mają fizyczne odzwierciedlenie kodu. Tak więc klasa Car, User, Product są jak najbardziej poprawne.

Metody
Metody należy opatrywać nazwami będącymi czasownikami lub wyrażeniami czasownikowymi, ponieważ mają one na celu wykonywanie pewnych akcji na obiektach. Kiedy oddajemy nasz samochód do mechanika, chcemy aby go naprawił. Wykonanie metody Repair na obiekcie Car ma sens, prawda?
Akcesory i mutatory powinny mieć nazwy tworzone na podstawie nazwy obsługiwanej właściwości i być poprzedzone przedrostkiem get lub set

Dodano: 26 Czerwiec 2018