ASWI - Pokročilé softwarové inženýrství » ASWI 2017 » Platforma na správu dotazníků (FAV) - Problem Solvers

h1. Konvence vývoje

h2. 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).

* Nejdůležitější vlastnostní kódu je, aby byl snadno čitelný, udržovatelný a srozumitelný z hlediska ostatních vývojářů. 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 v ideálním případě podroben code review dalším členem/členy 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 odchylek od specifikace.    

h2. Obecné konvence kódu

* 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.

* Každá třída/soubor bude na začátku obsahovat komentář se jménem autora a datem vytvoření (případně popis funkcionality). Výraznější změny třídy/souboru budou společně s jejich popisem zaznamenány stejným způsobem. 

* Levá složená závorka následující za deklarací třídy, metody či podmínky, bude umístěna na stejném řádku, jako tato deklarace.  

* Odsazování kódu bude realizováno výhradně tabulátorem. Zobrazení tabulátoru jako konkrétní počet mezer si pak může každý vývojář nastavit v IDE podle své osobní preference.

h2. Konvence pro jazyk Java

* Při vývoji budou dodržovány standartní konvence jazyka java, popsané v tomto "dokumentu":http://www.oracle.com/technetwork/java/codeconvtoc-136057.html firmy Oracle.

* Každý modul/logický celek bude zvenčí přístupný pomocí rozhraní deklarujícího služby které poskytuje, název rozhraní bude končit slovem "Api", např.: PasswordVerificationApi. Název třídy implementující toto rozhraní bude končit slovem "Impl", např.: PasswordVerificationImpl. V případě rozhraní nezávislého na konkrétním modulu a definujícím obecnou funkctionalitu, bude pro pojmenování rozhraní použita jmenná konvence začínající písmenem "I", např.: IComparable, IPrintable.

h2. Konvence jazyka PHP

h2. Konvence dokumentace

h3. Úrovně nadpisů