Witam w drugiej części serii – Jak skutecznie programować? W poniższym artykule zwrócę uwagę na dosyć ważną sprawę czyli nazewnictwo zmiennych.
W pierwszej części pisałem jak ważne jest komentowanie podczas programowania. Ten post spojrzy na problem nazewnictwa zmiennych. Jeżeli programowałeś już w przeszłości strony lub zamierzasz je programować pamiętaj o fakcie, że czasem trafi Ci się strona napisana przez innego programistę. Z drugiej strony napisane przez Ciebie strony może trafią kiedyś pod opiekę innego programisty.
Po pierwsze nie utrudniajmy pracy innym, a inni nie będą utrudniali nam.
Nazwa zmiennych często uważana jest za błahostkę, szybko wpisujemy nazwę, która często nie ma żadnego znaczenia tylko z powodu, że wydaje nam się, że intuicyjnie będziemy pamiętać do czego ona służy. Jednak sprawa nie jest taka prosta gdy w 1000 linijek musimy użyć kilkunastu zmiennych, które będą spełniać różne funkcje i przechowywać będą różne wartości.
Ta sama sprawa tyczy się nazywaniu klas oraz identyfikatorów w CSS
Jedną z najważniejszych zasad jest nie opisywanie zmiennych według tego jak wyglądają, lecz tego co przechowują lub jak funkcjonują. Dla przykładu:
maly_czerwony_element_po_prawej
3 podstawowe sprawy – co jak będziemy chcieli, żeby nasz mały czerwony elemencik był niebieski? Po drugie co wtedy gdy będziemy chcieli mieć go po lewej? Po trzecie – kto to zapamięta?
menu_bg
Czasem lepiej sięgać do języka angielskiego, też stąd występujące bg, którym oznaczam wszystkie elementy strukturalne będące tłem danego elementu. Ten przykład, sprawdzi się raczej w CSS. W przypadku PHP także pamiętajmy, żebyśmy tworzyli zmienne w oparciu o ich funkcję, np.
$zmienna_001 może być przecież zmieniona na $user_name, jeżeli będzie przechowywać nazwę użytkownika. Oczywiście ten przykład pokazuję bardzo oczywisty przypadek, kiedy zamiast ułatwiać sobie, utrudniamy wpisując na szybko co tylko nam wpadnie do głowy.
Mam nadzieję, że druga część z cyklu – Jak skutecznie programować? uczuli Was na problem nazywania zmiennych w projektach. Powodzenia w pisaniu czystego i przejrzystego kodu.
Jeżeli chcesz być zawsze na bieżąco co się dzieję na limefactory.pl zachęcam do subskrypcji RSS.