Čistý kód vám zjednoduší vývoj a ušetří práci. Jak na něj?

Usnadněte si vývoj, zlepšete spolupráci v týmu a vytvořte méně chybovou, kvalitnější a dlouhodoběji funkční webovou nebo mobilní aplikaci. S tím vším vám pomůže tzv. čistý kód, code review a pravidelná aktualizace. Jak na to, se dozvíte v dalším díle podcastu.

Buďte vždy o krok před konkurencí, získejte přístup k plné verzi podcastu i k celé sérii. Přihlaste se k odběru našeho newsletteru.

Nové technologické okénko je zde

Tentokrát si v našem technologickém okénku povídal CEO Pixape Radek Semančík a programátoři Vojtěch Seidler a Josef Štěpánek o tom, jaké výhody vám přinese „čistý kód“, co je code review a jak udržovat aplikaci jako celek.

Co je to čistý kód?

Čistý kód je pojem, který označuje takový kód, který je přehledný, strukturovaný a umožňuje snazší kontrolu, úpravy, spolupráci programátorů i své znovupoužití v dalším projektu. Ušetří vám tedy spoustu práce i starostí. Jak na něj?

Co vše by měl splňovat čistý kód?

1. Přehledná struktura a hierarchie – Čistý kód se opírá o jasnou a logickou strukturu projektu, který je přehledně rozdělený do různých složek a souborů. Tyto složky a soubory by pak vždy měly být jasně pojmenované. Pravidlem navíc je, že jeden soubor by neměl mít více než 1 000 řádků kódu. Pokud hrozí, že by měl více, je dobré ho rozdělit.
    
2. Dobře naimplementované objektové programování s dědičností – V projektu by mělo být co nejméně duplicitních funkcí. To se řeší dědičností a objektově orientovaným programováním. Díky němu nemusíte vytvářet pořád dokola stejné funkcionality, ale stačí vytvořit hlavní třídu, rodiče, po kterém pak dědí ostatních funkce a využívají jeho funkcionality. Tato praxe ulehčuje testování a odlaďování chyb. Stačí totiž otestovat funkci pouze v hlavní třídě a již ji nemusíte testovat v jejích potomcích, kteří ji používají.
    
3. Správně použité názvy funkcí a proměnných – Častou chybou začátečníků je špatné pojmenování proměnných. Když totiž máte funkci, která něco vykonává, a máte v ní nějaké proměnné, které se jmenují třeba „a“, „n“, „v“, snadno můžete zapomenout, co dělají, a musíte jít hluboko do kódu, abyste zjistili, jakou hodnotu ta daná proměnná nabývá.
    
4. Dodržování standardu kódu – V kódu by měly být samozřejmě dodržovány nějaké standardy psaní tzv. coding standards neboli formátování kódu podle předem domluvených pravidel.

Proč je třeba dělat code review?

Co je code review? Jde ve své podstatě o fázi vývoje, kdy jeden vývojář napíše kód a druhý ho po něm zkontroluje. Z jakého důvodu se tento code review dělá?

Jaké jsou důvody pro code review?

1. Odhalení chyb – Hlavní důvod je samozřejmě odhalení chyb v kódu.
    
2. Zachování standardu kódu – Dalším důvodem je udrženích standardů kódu.
    
3. Kontrola funkcionality – I když je ale vše správně a dle standardů, může se objevit i další problém. Kód totiž nemusí dělat to, co měl. Ačkoliv kód vždy vzniká pro uskutečnění nějakého požadavku, může se stát, že vznikne nějaká nejasnost nebo nedorozumění. To pak právě také kontroluje další vývojář. Přečte si, co mělo být vstupem a výstupem dané funkcionality, a zkontroluje, zda je tomu opravdu tak.

Jak tedy vidíte, code review je ve své podstatě dvojité testování aplikace.

Nejen čistý kód a code review jsou potřeba k bezchybnějšímu běhu aplikace, tj. kvalitnějšímu produktu, ale také pravidelná aktualizace na nejnovější balíčky knihoven, frameworky a verze programovacího jazyka. Pro aplikaci ostatně platí to samé, co pro auto, pokud nebudete dělat pravidelné kontroly, sice vám může jezdit dlouhou dobu bez starostí, ale pak se najednou už nerozjede. Proč tomu tak je?

Například knihovny jejich vývojáři mohou aktualizovat, aby napravili jejich chyby a nedostatky. Proto je i vy musíte pravidelně aktualizovat, aby vše fungovalo tak, jak má. Framework je pak vhodné aktualizovat v okamžiku, kdy přestává být jeho verze výrobcem podporována.

Proč aktualizovat balíčky, frameworky a programovací jazyk včas?

Když používáte například framework Symfony verzi 4.9 a přecházíte na verzi 5, není to žádný zásadní skok a všechny změny často jednoduše vyčtete z change logu. To samé platí i pro všechno, co se o tento framework opírá a koexistuje spolu s ním.

Jinak je to však, když přecházíte z verze 2 na 5. Tehdy jsou již změny natolik složité, že se spíše vyplatí naprogramovat zcela novou aplikaci. V tomto případě je opravdu snazší přenést již vymyšlenou logiku do nového projektu než se pokoušet o aktualizaci.

Z toho hlediska je důležité vždy dělat pravidelnou aktualizaci, protože v opačném případě hrozí, že budu muset za nějaký čas napsat celou aplikaci znovu.

Jak zajistit kvalitní a funkční aplikaci?

Jak tedy vidíte, klíčem k opravdu kvalitní a dlouhodobě funkční aplikaci, jejíž jednotlivé části budete moci opětovně použít a jejíž vývoj a spolupráce na něm bude mnohem efektivnější, je nejen čistý kód, ale i kontrola s pomocí code review a pravidelná aktualizace.

Chcete znát více o tom, jak dělat úspěšné aplikace nebo potřebujete vývojářský tým? Ozvěte se nám.