Ninjův kód

Učení bez myšlení je zbytečná práce; myšlení bez učení je nebezpečné.

Tyto triky používali programátorští ninjové v minulosti, aby zostřili mysl údržbářů kódu.

Zasvěcení recenzenti kódu je hledají v testovacích úlohách.

Začínající vývojáři je někdy používají ještě lépe než programátorští ninjové.

Pozorně si je přečtěte a zjistěte, kdo jste – ninja, začátečník, nebo snad recenzent kódu?

Stručnost je duší důvtipu

Snažte se napsat kód co nejkratší. Ukažte všem, jak jste chytří.

Nechte se vést jemnými prvky jazyka.

Podívejte se například na tento ternární operátor '?':

// převzato z dobře známé JavaScriptové knihovny
i = i ? i < 0 ? Math.max(0, len + i) : i : 0;

Hezké, ne? Budete-li takhle psát, zažije vývojář, který narazí na tento řádek a bude se snažit porozumÄ›t, jaká je hodnota i, veselé chvíle. Pak pÅ™ijde za vámi a bude žádat odpověď.

Řekněte mu, že co je kratší, to je vždy lepší. Zasvěťte ho do cest ninjů.

Jednopísmenné proměnné

Dao spočívá v bezeslovnosti. Jedině Dao správně začíná a správně končí.

Další způsob, jak zkrátit kód, je vÅ¡ude používat jednopísmenné názvy promÄ›nných, napÅ™. a, b nebo c.

Krátká promÄ›nná se v kódu ztratí jako opravdový ninja v lese. Nikdo ji nebude moci najít pomocí funkce hledání v editoru. A i kdyby ano, nedokáže „rozÅ¡ifrovat“, co názvy a nebo b znamenají.

…Je tady vÅ¡ak jedna výjimka. Opravdový ninja nikdy nepoužije i jako čítač v cyklu „for“. VÅ¡ude, jen ne tam. Jen se rozhlédnÄ›te kolem, existuje spousta exotičtÄ›jších písmen, napÅ™. x nebo y.

Exotická promÄ›nná jako čítač v cyklu je obzvláštÄ› půvabná, jestliže tÄ›lo cyklu zabírá 1-2 stránky (můžete-li, napiÅ¡te je co nejdelší). Když se potom nÄ›kdo podívá hloubÄ›ji do cyklu, nebude schopen rychle pÅ™ijít na to, že promÄ›nná x je čítač cyklu.

Používejte zkratky

Jestliže týmová pravidla zakazují používat jednopísmenné a vágní názvy, zkracujte je. Vytvářejte zkratky.

Třeba takto:

• seznam → szn.
• uživatelskýAgent → ua.
• prohlížeč → prhl.
• …atd.

Jedině osoba s opravdu dobrou intuicí pak bude schopna takové názvy pochopit. Snažte se zkrátit všechno. Jen úctyhodný člověk pak bude moci podpořit vývoj vašeho kódu.

Stoupejte vzhůru. Buďte abstraktní.

velký čtverec nemá rohy
velkou nádobu neuděláš hned
velký tón není slyšet
velká podoba je bez tvaru

Když volíte název, snažte se použít co nejabstraktnÄ›jší slovo. TÅ™eba obj, data, hodnota, prvek, element a podobnÄ›.

• Ideální název promÄ›nné je data. Používejte jej vÅ¡ude, kde můžete. Každá promÄ›nná pÅ™ece obsahuje nÄ›jaká data, ne?

  …Ale co když je název data už zabrán? Zkuste hodnota, to je také univerzální. Koneckonců každá promÄ›nná nakonec bude mít nÄ›jakou hodnotu.

• Pojmenujte promÄ›nnou podle jejího typu: řetězec, číslo…

  Zkuste to. Mladý učedník se může divit – jsou takové názvy pro ninju opravdu užitečné? Ale ano, jsou!

  Jistě, takový název proměnné stále něco znamená. Říká, co proměnná obsahuje: řetězec, číslo nebo něco jiného. Když se však outsider pokusí porozumět kódu, bude překvapen, že vidí, že název neobsahuje vlastně vůbec žádnou informaci! A nakonec se mu nepodaří váš skvěle promyšlený kód změnit.

  Datový typ proměnné lze snadno odhalit při ladění. Ale jaký je význam proměnné? Jaký řetězec nebo číslo je v ní uloženo?

  Není způsob, jak to odhalit bez dobré meditace!

• …Ale co když žádné další takové názvy už nezbývají? Stačí pÅ™idat číslo: data1, prvek2, element5…

Zkouška pozornosti

Vašemu kódu by měl porozumět jen skutečně pozorný programátor. Ale jak to zajistit?

Jeden způsob – používejte podobné názvy promÄ›nných, napÅ™. datum a data.

Směšujte je všude, kde je to možné.

Takový kód je pak nemožné rychle přečíst. A když je někde překlep… Hmmm… Nadlouho nás to zdrží, uděláme si přestávku na čaj.

Chytrá synonyma

Tao, které se dá popsat slovy, není stálé Tao
jméno, které se dá jmenovat, není věčné jméno

Používání podobných názvů pro stejné věci činí život zajímavějším a ukáže publiku vaši kreativitu.

Zvažte například prefixy funkcí. Jestliže funkce zobrazuje zprávu na obrazovce, začnÄ›te její název zobraz…, napÅ™. zobrazZprávu. Pokud pak jiná funkce zobrazí na obrazovce nÄ›co jiného, tÅ™eba uživatelské jméno, začnÄ›te její název vypiš… (napÅ™. vypišJméno).

To naznačuje, že mezi těmito funkcemi je nějaký drobný rozdíl, přestože ve skutečnosti žádný není.

DohodnÄ›te se s kolegy ninji z týmu: bude-li Honza pojmenovávat „zobrazovací“ funkce ve svém kódu zobraz..., pak Petr by mohl používat vypiš... a Anna vykresli.... VÅ¡imnÄ›te si, nakolik se kód stane zajímavÄ›jším a rozmanitÄ›jším.

…A nyní přijde ten pravý trik!

Pro dvě funkce, mezi nimiž je důležitý rozdíl, použijte stejný prefix!

Například funkce tiskniStránku(stránka) bude tisknout na tiskárnu. Ale funkce tiskniText(text) vypíše text na obrazovku. Nechte neznalého čtenáře, aby se zamyslel nad podobnÄ› pojmenovanou funkcí tiskniZprávu: „Kam tu zprávu vlastnÄ› vytiskne? Na tiskárnu, nebo na obrazovku?“ Aby to bylo opravdu úchvatné, tiskniZprávu(zpráva) by mÄ›la zobrazit zprávu v novém oknÄ›!

Používejte opakovaně stejné názvy

když rozdělujeme jednotu,
objevují se jména
pohromÄ› se vyhneme,
jen když víme, kdy přestat

Přidejte novou proměnnou jen tehdy, když je to absolutně nezbytné.

Jinak místo toho opakovaně používejte již existující názvy. Jen do nich zapisujte nové hodnoty.

Ve funkci se snažte používat jedině proměnné, které byly předány jako parametry.

Díky tomu je opravdu těžké poznat, co vlastně proměnná obsahuje právě teď. A také, odkud to přišlo. Cílem je procvičit intuici a paměť člověka, který čte kód. Osoba se slabou intuicí bude muset analyzovat kód řádek po řádku a stopovat změny v každé větvi.

Pokročilá varianta tohoto přístupu je utajeně (!) nahradit hodnotu něčím podobným uvnitř cyklu nebo funkce.

Například:

function ninjovaFunkce(elem) {
  // 20 řádků kódu pracujícího s elem

  elem = clone(elem);

  // 20 dalších řádků kódu, které nyní pracují s klonem proměnné elem!
}

Kolega, který bude chtít pracovat s promÄ›nnou elem ve druhé polovinÄ› funkce, bude pÅ™ekvapen… Teprve pÅ™i ladÄ›ní po prozkoumání kódu pÅ™ijde na to, že pracuje s klonem!

Toto je v kódu často vidět. Je to hrozivě efektivní i proti zkušenému ninjovi.

Legrace s podtržítky

UmisÅ¥ujte pÅ™ed názvy promÄ›nných podtržítka _ a __. Například _jméno nebo __hodnota. Bude to legrace, když budete jejich význam znát jenom vy. Nebo jeÅ¡tÄ› lépe: pÅ™idávejte je jen pro legraci, aniž by mÄ›la nÄ›jaký konkrétní význam. Nebo aÅ¥ mají na různých místech různé významy.

Zabijete dvě mouchy jednou ranou. Za prvé, kód se prodlouží a stane se méně čitelným, a za druhé, kolega vývojář může strávit dlouhou dobu zjišťováním, co vlastně ta podtržítka znamenají.

Elegantní ninja na jednom místě kódu podtržítka vkládá a na jiných se jim vyhýbá. Díky tomu je kód ještě zranitelnější a zvyšuje se pravděpodobnost budoucích chyb.

Ukažte svou lásku

Dejte každému vÄ›dÄ›t, jak úžasné jsou vaÅ¡e entity! Názvy jako superElement, megaRámec nebo pěknýPrvek čtenáře zaručenÄ› osvítí.

JistÄ›, na jednu stranu musíte nÄ›co napsat: super.., mega.., pěkný... Ale na druhou stranu to neposkytuje žádné detaily. ÄŒtenář se může rozhodnout hledat jejich skrytý význam a strávit meditací hodinu nebo dvÄ› své placené pracovní doby.

Dejte každému vÄ›dÄ›t, jak úžasné jsou vaÅ¡e entity! Názvy jako superElement, megaRámec nebo pěknýPrvek čtenáře zaručenÄ› osvítí.

Překrývejte vnější proměnné

Kdo je na světle, nevidí nic, co je ve tmě.
Kdo je ve tmě, vidí všechno, co je na světle.

Používejte stejné názvy pro proměnné vně a uvnitř funkce. Je to jednoduché. Není třeba úsilí k vymýšlení nových názvů.

let uživatel = autentikujUživatele();

function renderuj() {
  let uživatel = jináHodnota();
  ...
  ...mnoho řádků...
  ...
  ... // <-- programátor zde chce pracovat s uživatelem a...
  ...
}

Programátor, který skočí dovnitÅ™ funkce renderuj, si pravdÄ›podobnÄ› nevÅ¡imne, že v ní je lokální promÄ›nná uživatel, která zastiňuje tu vnÄ›jší.

Pak se pokusí pracovat s promÄ›nnou uživatel pÅ™edpokládaje, že je to externí promÄ›nná, která je výsledkem volání autentikujUživatele()… A past sklapne! Nazdar, debuggere…

Všude vedlejší efekty!

Existují funkce, které vypadají, jako by nic nemÄ›nily. Například jePřipraven(), ověřOprávnění(), najdiZnačky()… PÅ™edpokládá se, že provedou výpočty a najdou a vrátí data, aniž by mÄ›nily cokoli mimo nÄ›. Jinými slovy, bez „vedlejších efektů“.

Opravdu krásný trik je přidat do nich kromě hlavního úkolu ještě nějakou „užitečnou“ akci navíc.

Pohled na pÅ™ekvapenou tvář vaÅ¡eho kolegy, který zjistí, že funkce pojmenovaná je.., ověř.. nebo najdi.. nÄ›co mÄ›ní, zaručenÄ› posune hranice vaÅ¡eho rozumu.

Další cestou, jak překvapit, je vrátit nestandardní výsledek.

PÅ™edveďte své originální myÅ¡lení! Nechte funkci ověřOprávnění vrátit nikoli true/false, ale složitý objekt s výsledky ověření.

Vývojáři, kteří se pokusí napsat if (ověřOprávnění(..)), se budou divit, proč to nefunguje. ŘeknÄ›te jim: „PÅ™ečtÄ›te si dokumentaci!“ A dejte jim odkaz na tento článek.

Silné funkce!

Velké Tao se rozlévá, kam chce

Neomezujte funkci na to, co je uvedeno v jejím názvu. Rozšiřte se.

Například funkce zkontrolujEmail(email) by mohla (kromÄ› kontroly, zda email je správnÄ›) zobrazit chybovou zprávu a požádat uživatele, aby email zadal znovu.

Přidané akce by neměly být zřejmé z názvu funkce. Opravdový ninja je učiní nezřejmými dokonce i z kódu.

Spojení několika akcí do jedné ochrání váš kód před opakovaným použitím.

PÅ™edstavte si, že jiný vývojář bude chtít jen zkontrolovat email a nevypisovat žádnou zprávu. VaÅ¡e funkce zkontrolujEmail(email), která dÄ›lá obojí, mu pak nebude vyhovovat. NepÅ™ekazí tedy vaÅ¡i meditaci tím, že se na ni bude ptát.

Shrnutí

Všechny výše uvedené „rady“ pocházejí ze skutečného kódu… Někdy byl dokonce napsán zkušenými vývojáři. Možná ještě zkušenějšími, než vy ;)

• Když budete dodržovat nÄ›které z nich, bude váš kód plný pÅ™ekvapení.
• Když budete dodržovat mnohé z nich, bude váš kód opravdu jen váš a nikdo ho nebude chtít mÄ›nit.
• Když budete dodržovat vÅ¡echny, bude váš kód cennou lekcí pro mladé vývojáře toužící po osvícení.