Ako vie pomôcť CleanCode prehľadnosti formátovania kódu?

CleanCode a formátovanie kódu

Formátovanie kódu zohráva významnú úlohu v prehľadnosti celého kódu.

Formátovanie kódu sa líši v závislosti od programovacieho jazyka. Ako teda postupovať? Ak chcete vedieť aké štandardy formátovanie kódu sú pre Javu, tak do Googlu napíšte "Java style guide". Snažte sa dodržať formátovanie kódu špecifické pre váš programovací jazyk.

CleanCode pre formátovanie kódu rozlišujeme na horizontálne a vertikálne formátovanie.

Vertikálne formátovanie kódu podľa CleanCode

Vertikálne formátovanie kódu je predstavuje formátovanie zhora-nadol. Váš kód by mal byť čitateľný ako slohová práca v škole. Mali by ste ho čítať od hora dole bez príliš veľa skokov.

Pokiaľ máte viacero myšlienkových konceptov v jednom súbore (typicky viacero tried), rozdeľte ho na viaceré súbory. Jednotlivé oblasti kódu by mali byť rozdelené vertikálnymi medzerami (riadkami s entermi). Je samozrejmosťou, že vertikálne medzery používate medzi metódami.

Platí, že rovnaký myšlienková oblasť by nemala byť oddelená medzerami. Jednotlivé myšlienkové koncepty je nutné v jednom súbore uviesť pri sebe. Napr. ak verejná metóda volá privátnu metódu, táto privátna metóda by mala byť uvedená za verejnou metódou. To však neplatí v prípade, ak je dotyčná privátna metóda volaná napr. s viacerých verejných metód. V tom prípade nasleduje až za poslednou verejnou metódou, ktorá ju volá (pozor na to, že sú programovacie jazyky, ktoré umožňujú volanie metódy až po jej deklarácií, čo samozrejme, mení situáciu). Čo ta týka privátnych a verejných členov, tak platí, že je vhodné uvádzať pri sebe privátne vlastnosti / metódy a verejné vlastnosti /metódy. Poradie, ktoré bývajú prvé (či privátne alebo verejné) zväčša záleží od konkrétneho programovacieho jazyka.

Kurz UML - Základy jazyka UML v nástroji Enterprise Architect