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 "best practices" 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ý, co nejjednodušší a 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 proto použity pouze v odúvodněných případech (komplikovaná či špatně čitelná funkcionalita, popis rozhraní).

• Nový kód bude podroben code review dalším členem týmu. Tím se docílí dodržování zde uvedených konvencí a zároveď napomůže včasnému odhalení chyb, nesrovnalostí či odchýlení od specifikace.

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 pro srozumitelnost psány česky.

Konvence pro Jazyk java¶

Styl kódu jazyka Java

• Při vývoji budou dodržovány konvence popsané v tomto dokumentu