Poznáváme C# a Microsoft.NET 21. díl – komentování a dokumentace

Diskuze čtenářů k článku

Azazel@email.cz  |  29. 04. 2005 09:31  | 

Dovolím si úryvek z coding standatdu jedné nejmenované sw firmy, se kterým se plně ztotožňuji:

"Potřebuje-li kód implementační komentáře, je vhodné se zamyslet nad jeho přepsáním."

(netýká se dokumentačních komentářů, ty mají trochu jiný cíl)


Ještě to zkusím trochu přeložit: Programujte tak, aby bylo na první pohled zřejmé co program dělá - pokud je funkci programu potřeba nějak složitě vysvětlovat v komentářích, tak je špatně napsaný - pokud není potřeba něco vysvětlovat, tak to nevysvětlujte.

Souhlasím  |  Nesouhlasím  |  Odpovědět
Kero  |  29. 04. 2005 13:13  | 

hmm, tak s tim bych uplne nesouhlasil. Obcas delam neco, co potrebuje trochu matematiky a tam neni zcela zrejme, co to dela. Nebo orezavani hluchych koncu a zacatku v mp3 - mohlo by se to vsechno napsat na x radek, ale take na 1 radku s hafem bitovych operaci (trochu prehanim) - pokud strukturu mp3 neznas, tak ti oboje prijde zcela nesmysne, jenom to prvni je o dost kratsi.
Mozna si pletu jen dokumentacni komentar s implementacnim, ale iluze, ze budu cist program a okamzite vedet proc co a jak me uz davno opustila.

Souhlasím  |  Nesouhlasím  |  Odpovědět
Azazel@email.cz  |  29. 04. 2005 15:04  | 

Jistě, jsou věci kterým ani není možno rozumět na první pohled a které je pak potřeba důkladně zdokumentovat, ale to se rozhodně netýká 98% programů (u některých projektů bych si dovolil říct, že i 100%)

a když někdo napíše program na jednu řádku místo na deset (s pomocí nějakých kouzel ;) jenom proto, že to "jde",
tak to není dobrý programátor...

- vždy se najdou výjimky (např. u rychlostní optimalizace některých časově kritických funkcí), ale nemůžeme se přeci řídit výjimkami...

Souhlasím  |  Nesouhlasím  |  Odpovědět
cowgaR  |  03. 05. 2005 19:03  | 

tak to je BLUD taky velky ako je velky trapas tohto "prepiseme kapitoly C# knihy v strucnej podobe" serialu...

resp. je to nejaky vytah z urcitej prirucky "roku 70satych" kde sa viac pila kava ako sa kodovalo...

Souhlasím  |  Nesouhlasím  |  Odpovědět
mosquito, mosquito  |  29. 04. 2005 23:47  | 

pozivam komentare spis pri vyvoji a pak je mazu :) ... moje nejoblibenejsi je "// TODO" :))

Souhlasím  |  Nesouhlasím  |  Odpovědět
madMax  |  30. 04. 2005 00:01  | 

jj, to pouzivam taky strasne rad horsi je, kdyz neco dodelas, projdes si peclive kod a par jich tam najdes

Souhlasím  |  Nesouhlasím  |  Odpovědět
cowgaR  |  03. 05. 2005 18:58  | 

ake todo, najlepsie je predsa BUGBUG chlape

Souhlasím  |  Nesouhlasím  |  Odpovědět
avatar
24. 11. 2007 13:19 | 

Programovou oflline verzi seriálu naleznete ke stažení na http://poznavame-c-msnet.wz.cz/

Souhlasím  |  Nesouhlasím  |  Odpovědět
Zasílat názory e-mailem: Zasílat názory Můj názor

Aktuální číslo časopisu Computer

Speciál o přechodu na DVB-T2

Velký test herních myší

Super fotky i z levného mobilu

Jak snadno upravit PDF