Přehlednost programu

I laik by se měl vyznat ve vašem návrhu, ať již se jedná o předběžný náčrt algoritmu či finální produkt. Nesnažte se proto kód znepřehledňovat či psát již od začátku nesrozumitelný. Je povolena jediná výjimka - nemá-li být váš program open-source, je možné pomocí některých šifrovacích programů znesnadnit jeho dekódování. My si probereme zásady tvorby správného a čitelného kódu.

• Při tvorbě programu neporušujte zákony, ani mravní normy (žádné procedury se sprostým názvem!!!)
• Snažte se, aby zdrojový kód byl co nejsrozumitelnější
  • Sami byste se v něm měli vyznat, až se k němu třeba za rok vrátíte
• Při tvorbě programu by měla být patrna struktura návrhu odshora dolů
  • Nejprve rozhodněte, co bude program dělat, rozdělte činnost na jednotlivé úkoly a ty pak zpracujte jako samostatné procedury či alespoň jako oddělené bloky
  • Při definici procedur zachovejte jejich pořadí stejné jako v programu, Podprocedury ovšem musí předcházet hlavním procedurám atd., nejdříve tedy definujte podpodprocedury, pak podprocedury a nakonec procedury, vždy ale zachovejte pořadí...
  • Nepřehánějte to s definicí podprocedur, tři-čtyři úrovně téměř vždy bohatě postačí
• Volte smysluplné a výstižné názvy identifikátorů
  • Identifikátory začínejte vždy velkým písmenem, tAuto není tedy zrovna vhodný název
  • Proměnné typu ukazatel začínejte vždy P : PAuto
  • Názvy hodnot výčtového typu začínají vždy zkratkou daného typu (malými písmeny) tedy DnyTydne=(dtPondeli, dtUtery...)
  • Jednotlivé identifikátory by se neměly plést
  • Není vhodné předefinovat jakoukoliv pascalskou funkci (ani z jednotek, které zrovna nepoužíváte)
• Oddělujte části textu několikařádkovými mezerami
  • Vhodné je oddělit
    • Hlavičku
    • Deklarace a definice
    • Tělo programu
    • Část interface od implementation a begin...
    • Jednotlivé funkce a procedury
    • Text rozdělit na souvislé bloky (pohyb kurzoru, kontrola hracího pole, výběr nejvhodnějšího tahu,...)
• Pište komentáře
  • Krátké, stručné výstižné
  • Uzavřené do složených závorek
  • V hlavičce uveďte, co program dělá, co není hotové, s čím má problémy, jaký je požadovaný formát vstupních dat, jaký je výstup,...
  • Pomocí komentářů pojmenujte jednotlivé části programu
  • Vysvětlete činnost procedur, funkcí a podprogramů
  • U složitějších algoritmů poznamenejte, jak fungují, popř. kde jste je objevili a zda jste je ověřili
• Odsazujte (jeden nebo tři sloupce podle délky řádků)
  • Za každým beginem až k příslušnému endu.
  • Za case
  • Rozlište větve if... then ...else
  • Příkazy delší než jeden řádek napište tak, aby další řádek začínal alespoň jeden znak za začátkem původního příkazu (popř. vyššího řádku)..
  • Komentáře pište tak, aby bylo jasné, kam patří
• Využívejte podmíněný překlad
• Veďte si na kousku papíru seznam, co je třeba dodělat, poupravit, kde je třeba zvýšit přehlednost,...

Dcv: Upravte všechny své dosud napsané programy v duchu těchto zásad (snad vám to nebude trvat déle, než ty programy napsat !)