Úprava zdrojových textů

Jelikož na projektu pracuje řada skupin, je nutné pro přehlednost dodržovat některé konvence zápisu zdrojového kódu.Většina pracovních skupin má k dispozici pseudokód. Držte se rozložení do souborů a pokud je to možné i jmen funkcí, které jsou z modulů poskytovány do okolí (samozřejmě je v případě nutnosti možné provádět změny jak v pojmenování, tak v parametrech, ale je třeba o tom uvědomit skupiny, které na vaši část navazují ).

Každý zdrojové text (.C,.ASM) musí obsahovat hlavičku se jménem souboru, stručným popisem jeho účelu a jmény autorů. Je vhodné rovněž vyjmenovat vstupní body do modulu, jsou-li takové. Funkce je nutno koncipovat krátké a přehledné, dobře komentovat.

Hlavičky funkcí ve zdrojovém textu je dobré opticky zvýraznit takto:

/********************************************
                      my_func 
 ********************************************/
void myfunc(int param)

Některé zásady programování TUOXu

Úprava dokumentace systému TUOX

Všechny části systému musí být přehledně dokumentovány. Dokumentace je v HTML. Je možné použít češtiny s kódováním 1250, cestiny bez hacku a carek, popř. angličtiny. NEPOUŽÍVEJTE absolutní odkazy na jiné zdroje, všechny odkazy musí být z důvodu snadného přenosu celé dokumentace na jiný stroj nebo mimo prostředí internetu relativní.

WWW stránky obsahují následujici údaje: