Co je kvalitní kód a proč potřebujete code review?

Změnili jste vývojáře na svém projektu a ten říká, že existující kód aplikace je nepoužitelný? Nový tým věnuje hodně času jednoduchým úkolům? Jakmile se vypořádají s jedním problémem, rozpadne se něco dalšího? Nejpravděpodobnějším problémem je kvalita kódu.

Co je kvalitní kód?

Neexistuje přesné vymezení tohoto pojmu. Pochopení toho, jak by měl vypadat kvalitní zdrojový kód, je zpravidla založeno na dlouholetých zkušenostech specialisty. Někteří programátoři dodržují abstraktní princip KISS, který znamená "Keep It Simple, Stupid!" („Zachovej to jednoduché, hlupáku!“). Z části je tato metoda návrhu spravedlivá, protože odráží hlavní pravidlo dobrého kódu - jednoduchost a jasnost. Jednoduchost však často pletou se zjednodušením, proto je kvalita zdrojového kódu v profesionálním prostředí posuzována několika dalšími vlastnostmi:

• Vnímání. Kód není přetížen složitými konstrukcemi, proto je snadno srozumitelný i bez další dokumentace nebo připomínek;
• Podpora. V promyšleném kódu je snadné provést změny: změnit konfigurace nebo dokonce i platformy;
• Rozšíření. Do kvalitního kódu je jednoduché přidat nové funkce bez rizika porušení algoritmu kódu. I když jsou nějaké problémy, mohou být rychle odstraněny;
• Předání. Dobrý kód může být předán jiným vývojářům pro podporu nebo revizi a ti nebudou mít potíže při čtení;
• Testování. Čím vyšší je procentuální pokrytí kódu testy, tím je pravděpodobnější, že v budoucnu předejdete zbytečným chybám.

Pro usnadnění pochopení kódu v profesionálním prostředí má každý programovací jazyk svůj vlastní Code Style - návrhový standard. Code Style diktuje pravidla: kde umístit mezery nebo závorky, jak oddělit řádky nebo pojmenovat proměnné. Může se zdát, že tyto nuance nejsou tak důležité, ale jejich dodržování značně usnadňuje porozumění kódu těm, kdo ho vidí poprvé.

Málo programátorů umí psát opravdu dobrý kód. Zvlášť obtížné to je pro ty, kteří teprve zkušenosti získávají. Dokonce i kompetentní vývojáři mohou občas udělat chyby. Proto Studie, které vytvářejí vysoce kvalitní software, pravidelně provádějí kontrolu kódu.

Jak zlepšit kvalitu kódu?

Jeden z nejoblíbenějších a současně poměrně jednoduchý způsob se nazývá Code Review. Jeho význam spočívá v tom, že veškeré změny provedené programátorem se dostanou do hlavního úložiště kódů a do finální verze softwaru až poté, co budou zkontrolovány ostatními členy týmu.
Tento proces se skládá z několika etap.

V první fázi vývojář přidává nové funkce do kódu a upozorní ostatní účastníky, že potřebuje zkontrolovat tyto aktualizace.

V druhé fázi, členové týmu přezkoumají kód a připomínkují ho. Některé firmy se zaměřují pouze na zjištění chyb. Pokud ovšem chtějí zvýšit kvalitu kódu, měly by rovněž kontrolovat i chyby v architektuře, nesprávné použití nástrojů a špatný styl psaní, který může být nejasný nebo špatně vnímán.

Další etapou je práce s připomínkami. Pokud autor nesouhlasí s nějakou připomínkou, může ji odmítnout, avšak je nutné poskytnout přesvědčivé argumenty. Pokud neexistují žádné argumenty, provádí nezbytné opravy.

Po každé další aktualizaci kódu se tento proces vždy opakuje.

Výhody Code Review

Technika Code Review pomáhá v počáteční fázi najít chyby a zbavit se nepochopitelných a složitých řešení. Na kódu zpravidla nepracuje pouze jedna osoba, ale podílí se na tom celý tým. Tím často získáváme jiný pohled na věc.

Programátor, který předem ví, že jeho práce bude kontrolována kolegy, pracuje přesněji a organizovaně. Výstupem je kód, kterému rozumí více lidí, což vypovídá o jeho kvalitě. Pokud se skupina několika odborníků seznámí s kódem na vysoké úrovni, je pak daleko snazší jej předat dalšímu účastníkovi. Poté, pokud je potřeba, dokáže se každý účastník rychle prohloubit do práce a udělat ji kvalitativně.

Díky Code Review se sníží tzv. bus factor. Jedná se o pojem označující počet vývojářů, kteří podrobně znají zdrojový kód a jejichž odchod by projekt ohrozil nebo dokonce ukončil. Představte si projekt, který zaměstnává čtyři lidi. Pokud dva z nich z nějakého důvodu opustí projekt, pak je zbytek týmu schopný práci dokončit. Ovšem pokud tým opustí tři lidi, poslední účastník to sám nezvládne.

Nevýhody Code Review

Ve skutečnosti hlavní a jedinou nevýhodou tohoto procesu je čas. Vývojáři, kteří kontrolují nově napsaný kód, musí trávit čas hledáním případných chyb a v případě potřeby komentovat kód. Vývojář pak musí reportované chyby opravit. Nové části kódu se netestují hned, ale teprve po code review. Tento bod by měl být zohledněn při plánování.

Kdy používat Code Review?

Proces Code Review je poměrně jednoduchý a jeho výhody jsou znatelně větší než mínusy, ale v řadě situací se bez něj dokážete snadno obejít.

Například nemá smysl provádět Code Review při vývoji prototypu nebo MVP. Hlavním úkolem takového projektu je získání zpětné vazby od uživatelů s cílem vytvořit hypotézy pro další vývoj. Struktura těchto aplikací je co nejjednodušší a v budoucnu bude kód stále přepisován kardinálně.

Code Review není zapotřebí při práci na jednoduchých aplikacích, které se dál nevyvíjejí. Pokud tedy v budoucnu neplánujete měnit nebo upravovat svůj projekt, můžete ušetřit čas.

Pokud plánujete další vývoj aplikace, přidání nových funkcí a rozšiřování publika, proces Code Review vám pomůže to udělat rychleji, levněji a efektivněji. Kromě toho bude Code Review velmi užitečný, pokud z důvodu velikosti projektu plánujete připojit nové vývojáře nebo ho přenést do jiného týmu.