Šuplík Honzy Hučína

Skok na navigaci (menu)

Tento blog je v současné době uzavřen.
Pokračování blogu na bloguje.cz jsem zrušil. Pokud budu někdy pokračovat, bude to spíš tady.

Komentovaný článek

Internet a vše kolem

15. 3. 2006

Nejdůležitější značka v kódu

Jednoho dne nepřijde váš kolega do práce a šéf vám oznámí, že přebíráte za něho část úkolů. Zda byl vyhozen, dlouhodobě onemocněl, nebo se zabil při autonehodě (což byl náš případ), to vám může být jedno. Musíte se zorientovat a dodělat práci za něho.

Kdo to zažil, ví, že nejdůležitější značkou v kódu je komentář. Ať už je to HTMLácké  nebo /* */ (případně //), pokud se v kódu objeví a obsahují něco smysluplného, stávají se záchranným kruhem pro vás, pro projekt i v důsledku pro celou firmu.

Jasně, opatřit vlastní dílo komentářem, neřkuli úplnou dokumentací, to se zpravidla člověk musí trochu nutit. Dopíšu to později, teď ještě musím opravit tohle a rozchodit támhleto, říkáte si. Prozíravý programátor (a hlavně šéf) by ale měl dokumentaci vyžadovat a dávat jí prioritu. Vždyť kde má zaručeno, že mu pracovníka nepřetáhne někdo jiný a on nezůstane s efektivním, ale nesrozumitelným kódem?

Vložit vlastní komentář – Návrat k článku – RSS komentářů tohoto článku

Komentáře

[1] 15. 3. 2006, 10:49 – Vilém Málek (Odkaz)

On člověk ani nemusí přebírat kód po někom jiném. Stačí, když se sám snaží napsat co nejefektivnější aplikaci a za půl roku má do ní doplnit nějakou funkčnost nebo ji jen mírně upravit. A čím efektivnější kód, tím hůře se v něm člověk vyzná, i když je jeho vlastní...

[2] 15. 3. 2006, 11:00 – dgx

[1] asi tak. Jenže jsem zjistil, že v mém případě je problém už tak měsíc, o půl roku ani nemluvě. Dál totiž má paměť jaksi nesahá :-( No ještě že na tom nejsem tak špatně jako ten chlápek z Mementa :-)

[3] 15. 3. 2006, 15:49 – Lukáš Havrlant (Odkaz)

V PHP to asi důležité bude, to nepopírám, ale IMHO v HTML a vlastně i v CSS stačí rozumné názvy identifikátorů a tříd.

[4] 15. 3. 2006, 19:32 – Tomik

No vzhldem k tomu, že v html jsou celkem zaběhlé postupy, tak tam opravdu stačí pouze čitelné ID a CLASS.

Ale např. v PHP a jakémkoli jiném programovacím, či scriptovacím jazyce jsou komentáře nezbytnost.

Například v soutěži v programování (kdo ji někdy zažil dá mi zapravdu), tvoří asi 30 - 40% úspěchu komentáře...

[5] 15. 3. 2006, 19:50 – llook (Odkaz)

Pokud je komentářů moc, tak je něco špatně. Pěkně to popisuje Fowler v Refaktoringu.
I v tom PHP kolikrát stačí rozumné názvy identifikátorů plus sem tam nějaký ten docblock.

[6] 15. 3. 2006, 22:51 – Honza Hučín (Odkaz)

Je trochu rozdíl, zda něco dokumentuju pro sebe, nebo pro kolegu. Pokud pro sebe, pak samozřejmě stačí jen základní vysvětlivky a popisy trikových míst. Pro kolegu, který může vyvíjet jiný druh aplikací (např. je expert na sessions a objekty, ale ne tolik na SQL), je IMHO nutné komentovat i to, co je pro mě primitivní. V článku jsem měl na mysli tento druhý případ.

[7] 8. 4. 2006, 16:20 – Ice (Odkaz)

Zacal jsem spolupracovat na webech s grafikem. S photoshopem pracovat umim, ale kdyz chci neco upravit, tak mne nezbyde nez ho o to pozadat. Par nepopsanych vrstev a jsem nahrany. Casem se urcite sehrajem

K tomuto článku není možné vkládat komentáře.