"krájanie kódu", pomenovanie súborov, funkcií, premenných atd. rubrika: Folklór
Zdravím,
Mám na Vás 3 otázky ktoré asi sú časté, no zaujímal by ma práve váš názor.
Podľa čoho sa rozhodujete či určitú časť kódu obalíte do samostatnej funkcie? (tu je ešte síce celkom v podstate jasná odpoveď, ale trebárs u Angular controllerov či podobných vecí je to už také, nie úplne jasné, podobne aj u vue componentov)
Podľa čoho sa rozhodujete jak kód rozdelíte medzi súbory?
Podľa čoho určujete názvy súborov, funkcií, premenných atd.?
Skvělé otázky.
1) Kód obalím do samostatné funkce přesně v jakémkoli ze dvou případů: buď se nabízí pro daný blok dostatečně deskriptivní název nebo potřebuji v rámci projektu tento blok použít opakovaně (i tam se pokusím nalézt nějaký dobrý název). Totéž platí pro komponenty, třídy, apod.
2) Soubory tvořím obvykle podle konvencí nějakého frameworku nebo firemních konvencí. Nejvíc mi vyhovuje mít na jeden modul jeden soubor. Celkem přirozená věc ve světě JavaScriptu. Ve světě C# moduly ve stejné podobě nejsou, ale zhruba existuje nějaká centrální třída a další typy okolo (enumy, DTO, apod.). Tak soubor pojmenuji podle této centrální třídy a umístím do ní i ty typy okolo. Ve své podstatě mi jde o to, aby souborů nebylo zbytečně moc. Aby když se člověk podívá na projektovou strukturu, aby hned viděl a poznal, z čeho je aplikace složena, ale aby zároveň nebyl dezorientován příliš vysokou granularitou.
3) Jedna z nejtěžších, ale nejdůležitějších věcí vůbec (zvlášť u rozsáhlých projektů). Řídím se tím, že název považuji vždy za abstrakci. To znamená, že již z pojmenování by mělo být co nejlépe jasné, jak se používá a co znamená, aniž by bylo nutné zkoumat detaily. Pokud nedokážu zvolit název, hledám chybu spíše ve špatné dekompozici programu. Spokojen jsem tehdy, pokud již z názvu lze poznat jak se daná abstrakce používá a nemusím zkoumat detaily. Pokud to nedokážu dokonale, pak se to snažím popsat v komentářích. A ani to nedělám, pokud je užití samotné stručnější, než případný komentář.
Napiš pak, jak to děláš Ty, také mne zajímají vaše názory.
Pro zobrazení všech 4 odpovědí se prosím přihlaste:
Nebo se přihlaste jménem a heslem:
Komentáře