SAIL - estetyka kodu (teoria)
Właściwie moglibyśmy polemizować z materiałem tu zawartym, gdyż każdy ma inny pogląd na estetykę. Jednakże podstawą jest zachowywanie jej w pisanym kodzie.
Ze strony czysto technicznej estetyka nie jest wymagana. Kompilator przyjąłby kod nawet, gdyby został umieszczony w jednej linijce. Jednakże my nie jesteśmy tak zdolni jak on, więc dbamy o czytelność.
1. zasada: jedna komenda na linijkę
Zupełnie jak z karteczkami na lodówce. Lepiej przemówi do nas lista poleceń wypisana w pionie niż każda kolejna po przecinku.
2. zasada: wcięcia w kodzie
Polega to na przesuwaniu w bok (z użyciem Tab'a) kodu bardziej zagnieżdżonego, tzn. kiedy jeden blok kodu znajdzie się w drugim, lub po prostu przesuwanie w bok elementów wewnątrz takiego bloku:
begin Komenda1; Komenda2; end;
3. zasada: opatrywanie kodu komentarzami
Takie proste, a jak bardzo ułatwia życie...
4. zasada: podział nazw komend na logiczne partie
Wiem, wiem, trochę zagmatwane, ale w praktyce zawsze prościej (przykład z funkcją ComMoveToArea):
commovetoarea(parametry);
To tak, jakby ktoś zapisał: idźiwyrzućśmieci.
Jako, że nie możemy rozdzielić części nazwy funkcji spacjami, poszczególne z nich wyróżniamy wielką literą:
ComMoveToArea(parametry);
Nawet przykład wyglądałby lepiej: IdźIWyrzućŚmieci... No, ale my mamy chociaż spację.
5. zasada: spacja wszechobecna
Czasem zdarza nam się stworzyć listę wielu wartości. Pamiętajmy o prostej zasadzie, by rozdzielać je nie tylko przecinkiem, lecz i spacją:
Lista1:= [Radzio, nieRadzio, Radzio, nieRadzio];
Data utworzenia: 19 lipiec 2008