Która praktyka ZWIĘKSZA czytelność kodu źródłowego?
A. unikanie jakichkolwiek komentarzy
Źle. Komentarze w trudniejszych fragmentach pomagają.
B. nadawanie zmiennym jednoliterowych nazw
Źle. Skróty zaciemniają sens kodu.
C. pisanie jak najdłuższych linii w jednym wierszu
Źle. Bardzo długie linie utrudniają czytanie.
D. stosowanie wcięć i opisowych nazw zmiennych
Dobrze. Wcięcia i czytelne nazwy ułatwiają zrozumienie kodu.
Czytelność kodu najbardziej poprawiają WCIĘCIA (pokazujące strukturę bloków) oraz OPISOWE nazwy zmiennych i funkcji, z których od razu wynika ich rola. Dzięki temu kod łatwiej zrozumieć i utrzymać. Dlatego czytelność zwiększa stosowanie wcięć i opisowych nazw.
Pozostałe „praktyki” pogarszają czytelność. Bardzo długie linie wymuszają przewijanie i utrudniają czytanie. Całkowite unikanie komentarzy pozbawia wyjaśnień w trudniejszych miejscach. Jednoliterowe nazwy zaciemniają sens zmiennych. Pomagają wcięcia i opisowe nazwy.