Formátování kódu hraje významnou roli v přehlednosti celého kódu.
Formátování kódu se liší v závislosti na programovacím jazyku. Jak tedy postupovat? Pokud chcete vědět, jaké standardy formátování kódu jsou pro Javu, tak do Googlu napište „Java style guide“. Snažte se dodržovat formátování kódu specifické pro váš programovací jazyk.
CleanCode pro formátování kódu rozlišuje na horizontální a vertikální formátování.
Vertikální formátování kódu představuje formátování shora-dolů. Váš kód by měl být čitelný jako slohová práce ve škole. Měli byste jej číst shora dolů, aniž by příliš mnoho skoků.
Pokud máte více myšlenkových konceptů v jednom souboru (typicky více tříd), rozdělte jej na více souborů. Jednotlivé oblasti kódu by měly být rozděleny vertikálními mezerami (řádkami s entery). Je samozřejmostí, že vertikální mezery používáte mezi metodami.
Platí, že stejný myšlenkový blok by neměl být oddělen mezerami. Jednotlivé myšlenkové koncepty je nutno v jednom souboru uvést u sebe. Např. pokud veřejná metoda volá privátní metodu, tato privátní metoda by měla být uvedena za veřejnou metodou. To však neplatí v případě, je-li dotyčná privátní metoda volána například. z více veřejných metod. V tom případě následuje až za poslední veřejnou metodou, která ji volá (pozor na to, že jsou programovací jazyky, které umožňují volání metody až po její deklaraci, což samozřejmě mění situaci). Co se týče privátních a veřejných členů, platí, že je vhodné uvádět u sebe privátní vlastnosti / metody a veřejné vlastnosti / metody. Pořadí, které bývají první (ať privátní nebo veřejné) závisí na konkrétním programovacím jazyku.
Pokračovanie článku ako aj množstvo praktických ukážok nájdete v knižke.
Na to vám poslúži CleanCode Bibka. Malá CleanCode Biblia, ktorú v pohode zlúskate behom víkendu. Stiahnite si náš ebook teraz zdarma:
Marián Knězek