Konvence vývoje¶

Obecné konvence kódu¶

Fylozofie vývoje¶

Při vývoji budou v maximální možné míře použity/vyzkoušeny osvědčené techniky vývoje softwaru (vysoké pokrytí kódu testy, programování proti rozhraní a modularita, použití návrhových vzorů), které s rostoucí velikostí projektu nabývají na důležitosti. Cílem bude psát čistý a co nejsrozumitelnější kód.

• Kód bude členěn do malých, maximálně nezávislých logických celků (modulů/tříd) zpřístupněných rozhraním (API).

• Názvy proměnných/metod/tříd budou voleny s důkladným rozmyslem tak, aby byly maximálně popisné a samovysvětlující. Komentáře budou použity pouze tam, kde to bude nutné (složitější funkcionalita, metody rozhraní).

• Nový kód bude podroben code review dalším členem týmu. Tím se napomůže dodržování konvencí popsaných v tomto dokumentu a zároveď dojde

*

Lokalizace kódu a komentářů¶

Veškerý kód (názvy proměnných, tříd, metod...) bude psán v anglickém jazyce, komentáře kódu a popisy commitů budou psány česky.

*

• Názvy proměnných nechť jsou voleny tak, aby co nejlépe popisovaly

Komentování kódu¶