Konvence vývoje » Historie » Verze 4
Jan Kebrle, 2017-04-01 14:32
| 1 | 1 | Jan Kebrle | h1. Konvence vývoje |
|---|---|---|---|
| 2 | |||
| 3 | h2. Obecné konvence kódu |
||
| 4 | |||
| 5 | h3. Fylozofie vývoje |
||
| 6 | |||
| 7 | 2 | Jan Kebrle | 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. |
| 8 | 1 | Jan Kebrle | |
| 9 | * 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). |
||
| 10 | |||
| 11 | 4 | Jan Kebrle | * 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í). |
| 12 | 1 | Jan Kebrle | |
| 13 | 4 | Jan Kebrle | * 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. |
| 14 | 1 | Jan Kebrle | |
| 15 | |||
| 16 | 4 | Jan Kebrle | h3. Obecné konvence kódu |
| 17 | 1 | Jan Kebrle | |
| 18 | 4 | Jan Kebrle | * 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. |
| 19 | 1 | Jan Kebrle | |
| 20 | 4 | Jan Kebrle | * Každá třída/soubor bude na začátku obsahovat komentář se jménem autora a datumem vytvoření (případně popis funkcionality). Výraznější změny budou třídy/souboru budou společně s jejich popisem zaznamenány stejným způsobem. |
| 21 | 3 | Jan Kebrle | |
| 22 | 4 | Jan Kebrle | * |
| 23 | |||
| 24 | |||
| 25 | 1 | Jan Kebrle | h2. Konvence pro Jazyk java |
| 26 | |||
| 27 | 2 | Jan Kebrle | h3. Styl kódu jazyka Java |
| 28 | 4 | Jan Kebrle | * 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. |
| 29 | |||
| 30 | * 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. |