Dotaz: Jak se neztratit v kódu

[Mate]

Ahoj, měl bych netradiční dotaz na programátory kteří dělají velké věci. Nevím jak se neztratit v kódu. Už ani nepomáhá pořádné okomentování kódu. Vnoření je tak hluboké, že se těžce ztrácím jak to děláte vy? Neexistuje na to "něco" co by nám to ulehčilo ? Třeba nějaká aplikace ve které by se dal vytvořit nějaký virtuální pavouk a místo kódu by bylo jen info ? Asi plácám, ale fakt netuším jak dál. Díky za případné nápady.

---

---

Odpovědi

[Kit]

Zanoření by nemělo překročit 4 úrovně (např. třída, metoda, cyklus, podmínka). Když metodu nebudeš dělat delší než 20 řádek, tak s tím nebudeš mít problém.

[Sten]

Pokud je příliš velké vnoření, pravděpodobně ta třída nebo funkce dělá příliš mnoho práce a zasloužila by rozdělit. U dobře navrženého kódu toho pavouka dělají třídy, resp. calling graph.

[Matlák]

Metody "virtuální pavouk" nebude přehledná dokud nebude samotný kód přehledný. Pokud jsou v kódu pětisetřádkové metody/funkce které používají řadu vnořených cyklů a podmínek, ani z výsledné grafické reprezentace by případný nezasvěcený čtenář nebyl moc moudrý (což, bohužel, mnohdy platí i pro autora, který kód na pár měsíců či let "odložil").

Obecně bych doporučil metodu "rozděl a panuj", tzn. vnořené části rozdělit na funkce/metody, dlouhé funkce s mnoha zodpovědnostmi rozdělit do separátních souborů. Hodně taky pomáhá oddělit interface a implementaci (hlavičkové a implementační soubory) - mnohé jazyky takové konstrukce podporují, právě proto že jsou přehlednější. Člověk pak nemusí koukat do kódu, jen studuje jednotlivá rozhraní. Na základě rozhraní a jeho komentářů lze generovat i dokumentaci (javadoc,doxygen) a kýžená "grafická podoba" je potom přehledná a jasná

[Michal Kubeček]

(což, bohužel, mnohdy platí i pro autora, který kód na pár měsíců či let "odložil")

Nemyslím, že je tu slovo "bohužel" na místě. Takhle je aspoň o něco větší šance, že prozře, až bude nevěřícně zírat do svého vlastního kódu a proklínat to prase, které to psalo.

[Matlák]

Pravda, sem asi patří spíš "bohudík"

[pushkin]

Přesně můj případ. Před pár lety jsem stvořil program, jehož jádro je cca 40 řádek kódu. Už asi měsíc sbírám odvahu na to, do nich sáhnout.

[Kit]

Kostlivce ve skříni má snad každý. Mám jeden funkční monolitický skript, který má 700 řádek a už několikrát jsem se pokusil ho přepsat do OOP, což by mu určitě prospělo, protože by se zkrátil, zpřehlednil a zrychlil. Vždycky mi však do toho něco vleze a protože původní skript funguje, nechám to zase být.

[dustin]

Doporučuji ti přečíst si http://www.amazon.com/Clean-Code-Handbook-Software-Craftsmanship/dp/0132350882 , Vážně to člověku docela otevře oči.

[karl82]

Refactoring: Improving the Design of Existing Code a Refactoring to Patterns

[tacoberu]

Jedno konkrétní doporučení:

Piš třídu, funkci/metodu, cikl/podmínku tak, aby dotyčná funkce věděla co volá, ale nevěděla konkrétní implementaci, a aby nepředpokládala, že ji někdo bude používat nějakým konkrétním způsobem.