Jak správně psát zdrojový kód

1 Star2 Stars3 Stars4 Stars5 Stars (No Ratings Yet)

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

  1. Odsazení řádků musí odpovídat vnořeným blokům
  2. Jeden řádek – jeden příkaz (značka)
  3. Logické celky odděleny mezerou
  4. Dodržujte jednotné názvy objektů
  5. Identifikátory by měly co nejpřesněji popisovat význam
  6. Dodržovat formát pro konstrukce
  7. Každá funkčnost naprogramovaná pouze jednou
  8. Kód nesmí obsahovat magická čísla
  9. … a další pravidla vycházející z konkrétního standardu daného jazyka …

Pravidla psaní komentářů

  1. Komentáře nesmí duplikovat kód
  2. Komentář musí jednoznačně osvětlit popisovanou část kódu
  3. Komentuje se hlavička každého souboru, se kterým se pracuje
  4. Komentuje se hlavička všech objetků, funkcí a konstrukcí procedur
  5. Komentují se všechny netriviální konstrukce