Konvence vývoje » Historie » Revize 2
Revize 1 (Jan Kebrle, 2017-04-01 00:02) → Revize 2/8 (Jan Kebrle, 2017-04-01 00:19)
h1. Konvence vývoje h2. Obecné konvence kódu h3. Fylozofie vývoje Při vývoji budou v maximální možné míře použity/vyzkoušeny "best practices" 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ý, čistý a 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á tam, kde to bude nutné (složitější funkcionalita, popis metody rozhraní). * Nový kód bude podroben code review dalším členem týmu. Tím se docílí napomůže dodržování konvencí popsaných v tomto dokumentu a zároveď napomůže odhalení chyb či nesrovnalostí. dojde * h3. 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. h2. Konvence pro Jazyk java Obecné konvence jazky * * Názvy proměnných nechť jsou voleny tak, aby co nejlépe popisovaly h3. Styl kódu jazyka Java * *Komentování kódu*