Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (2)

Clive „Max” Maxfield

Kursy

Arduino

3 listopada 2023

509

W poprzedniej części wyjaśniłem, że ponieważ udostępniam kilka szkiców (programów) Arduino do pobrania, które towarzyszą bieżącej miniserii artykułów Ekscytacje Maxa, pomyślałem, że dobrym pomysłem może być uzasadnienie stylu kodowania, którego używam. W moim poprzednim artykule omawialiśmy o spacjach, komentarzach, instrukcjach #define i dlaczego używanie „magicznych liczb” jest złym pomysłem. Teraz zanurzmy się nieco głębiej w rzeczy takie jak konwencje nazewnictwa.

Poprzednia część

Spis treści

Następna część

1. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (1) 2. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (2) 3. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (3) 4. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (4) 5. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (5) 6. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (6) 7. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (7) 8. Sprytne porady i sztuczki cyklu Ekscytacje Maxa dotyczące kodowania (8)

Nazwy zmiennych

Ogólną zasadą jest używanie rzeczowników lub fraz rzeczownikowych (rzeczowników z modyfikatorami) w nazwach zmiennych, ponieważ ułatwia to czytanie kodu. Używam „camel case” dla nazw zmiennych. Oznacza to, że złożone słowa lub frazy są zapisywane w taki sposób, że każde słowo w środku frazy zaczyna się wielką literą, bez spacji i znaków interpunkcyjnych.

W przypadku zmiennych globalnych (które są deklarowane poza jakimikolwiek funkcjami i które są dostępne dla wszystkich funkcji), używam wielkich liter („pascal case”), w których pierwszy znak jest również wielką literą, na przykład:

Uzasadnienie: lubię wygląd dużych liter i uważam, że przekazują one wiele informacji w łatwym do odczytania formacie. Używanie wielkich i małych liter odpowiednio dla zmiennych globalnych i lokalnych pomaga mi wiedzieć, co jest czym, gdy czytam mój kod.

Nazwy funkcji

Jeśli chodzi o moje własne funkcje używam tych samych wielkich liter dla nazw funkcji, co dla zmiennych globalnych, ponieważ uważam funkcje za globalne (w Arduino musimy używać funkcji setup() i loop(), tak jak jest).

Ogólną zasadą jest używanie rzeczowników lub fraz rzeczownikowych (rzeczowników z modyfikatorami) jako nazw dla funkcji, które są „pobierającymi” lub „pytającymi” oraz używanie czasowników lub fraz czasownikowych dla funkcji, które są „wykonującymi” lub generują efekty uboczne.

Funkcje zwracające wartości logiczne (prawda/fałsz) zwykle mają nazwy zaczynające się od „Is”, „Has”, aby ułatwić odczytywanie wyrażeń.