Troška toho pořádku neuškodí – shrnutých pár základních bodů pro „slušné“ psaní zdrojových kódů. Samozřejmě, že se vždy musíme řídit i standardy daného jazyka, ve kterém programujeme. Ve druhé části následují pravidla pro psaní komentářů. Pravidla se samozřejmě dají využít i pro xHTML a nejen pro skriptovací a programovací jazyky.
Pravidla psaní kódu
- Odsazení řádků musí odpovídat vnořeným blokům
- Jeden řádek – jeden příkaz (značka)
- Logické celky odděleny mezerou
- Dodržujte jednotné názvy objektů
- Identifikátory by měly co nejpřesněji popisovat význam
- Dodržovat formát pro konstrukce
- Každá funkčnost naprogramovaná pouze jednou
- Kód nesmí obsahovat magická čísla
- … a další pravidla vycházející z konkrétního standardu daného jazyka …
Pravidla psaní komentářů
- Komentáře nesmí duplikovat kód
- Komentář musí jednoznačně osvětlit popisovanou část kódu
- Komentuje se hlavička každého souboru, se kterým se pracuje
- Komentuje se hlavička všech objetků, funkcí a konstrukcí procedur
- Komentují se všechny netriviální konstrukce