Písať alebo nepísať komentáre

10. 12. 2011 01:31:34

Kenthanio: Nick mám podle Atari 800XE. Na tom jsem dal kdysi dohromady první primitivní program a už mě to nepustilo :-).

10. 12. 2011 01:31:34

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706057

Tomáš Faldyna

(54 hodnocení)

10. 12. 2011 08:54:34

Komentare urcite ano! Neni nic horsiho nez po nekom studovat vetsinu kodu a hledat kde, co, co a jak dela... U malych jednoznacne pochopitelnych skriptu staci jedna veta, ale zase je dobre ze tam je :)

10. 12. 2011 08:54:34

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706056

Tom

(6 hodnocení)

10. 12. 2011 10:15:19

Komentáře stoprocentně - čím víc, tím líp.

10. 12. 2011 10:15:19

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706055

Tomáš Zíma

(6 hodnocení)

10. 12. 2011 16:03:39

Napsal Jadro007;731893
Komentáře stoprocentně - čím víc, tím líp.

To není tak úplně pravda, protože když to s komentováním přeženeš, kód znepřehledníš..

10. 12. 2011 16:03:39

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706054

Tom

(6 hodnocení)

10. 12. 2011 18:55:48

To je fakt, tak samozřejmě všeho s mírou - ale určitě je lepší více komentářů než žádné

10. 12. 2011 18:55:48

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706053

Tomáš Zíma

(6 hodnocení)

11. 12. 2011 16:04:45

Napsal Jadro007;732035
To je fakt, tak samozřejmě všeho s mírou - ale určitě je lepší více komentářů než žádné

Souhlasím.

11. 12. 2011 16:04:45

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706052

Martin Schlemmer

(36 hodnocení)

11. 12. 2011 20:45:18

Ovlivnil mě názor Martina Fowlera v Refactoringu.

Pokaždé, když má potřebu něco okomentovat, se podívá, jestli komentovaný blok nemůže raději extrahovat do nové metody a dát mu jméno, které by jeho záměr popisovalo místo komentáře.

Takže se snažím psát sebekomentující kód - takový, kde každý podstatný blok kódu je ve funkci nebo metodě, jejíž název vysvětluje smysl toho, co se děje uvnitř.

Komentáře ale samozřejmě píšu:

- komentuju samotné metody, hlavně pokud nejsou jasné jejich parametry ze signatury a návratová hodnota z názvu: metody začínající is- vrací boolean, vstupní parametry se snažím pojmenovat tak, aby bylo zřejmé, co je jejich smysl, evtl. i vynutit jejich typ (v PHP lze vynutit jen třídu nebo typ array, ne skalární typy)

- komentuju bloky kódu, které nelze extrahovat do vlastní funkce, nebo které provádí zvláštní trik, využívají nesamozřejmý postup (a nelze je přepsat, jinak je raději přepíšu)

Co se mi vyplatilo, a doporučují to i ostřílení programátoři:

V komentářích vysvětlete smysl komentovaného kódu, nepopisujte, co přesně dělá. Čtenář si přesný postup vyčte přímo z kódu, co mu bude chybět, je právě smysl.

Napište proč, ne jak.

11. 12. 2011 20:45:18

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706051

Kamil Tomšík

(3 hodnocení)

12. 12. 2011 23:13:06

Napsal Aleš Jiříček;731862
vase kecy o tom nepsat komentare at k tomu mate jakekoliv duvody me vazne uvadeji do varu... programator co nepise kometare k nejasnemu kodu (jasny ze ne ke kazde kravine se musi psat komentar) je podle me ten nejhorsi programator... proste komentare jsou zasadni pro upravy kodu... a to i pro vas samotne... kdyz se k tomu vratite za dva roky tak budete cumet jak blumy, pac nebudete tusit co ste to tam provadeli! jako jasny, kdyz si delate picoviny pro sebe, tak si delejte co chcete, ale zakazkova vyroba jen a pouze s komentarema, pokud nejste posrany vychcanci a nechcete aby klient musel jit za vama s upravama pac se ve vasem kodu nikdo nevyzna, tak proste delate komentare... v opacnem pripade jste amater nebo svine ani jedno do zakazkoveho programovani nepatri
edit: samozrejme nemluvim k lidem co tu komentare doporucuji, spis k prvnim prispevkum... treba Tkim... to je proste clovek ktreryho bych ve firme nechtel jako jen proto ze nebude na projektu pracovat porad a vi o tom tak mi tam nebude delat komentare? klasicka ceska svine nic vic

Martin to vystihl naprosto presne - pokazdne kdyz mam nutkani napsat komentar, zamyslim se nad tim, co dany kus kodu dela a vytvorim privatni metodu, pripadne udelam nejaky hlubsi refaktor. Komentare samy o sobe nejsou spatne, ale nejsou up-to-date, uz jsem se mnohokrat setkal s kodem, ktery delal neco uplne jineho, nez co bylo napsane v komentari - a minimalne jednou jsem na to zapomel i sam.

a doufam, ze jsem te patricne uvedl do varu ;)

12. 12. 2011 23:13:06

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706050

(20 hodnocení)

13. 12. 2011 00:07:27

neboj neuvedl, mluvil jsem hlavne a prevazne treba k uzivateli Tkim ebo podobnym kteri jednoznacne rekli neco ve smyslu "Pokud pracuješ ve firmě a děláš to pro někoho s výhledem, že tě třeba vyhodí tak bych se na to vyprdl." to je proste neco neskutecnyho, mit ve firme takovyho programatora tak ho zenu svinskym krokem

jinak ja osobne programuji podobne jako uvadi martin - selfexplain metody a objekty, komentare delam strucne jasne hlavne u nejasnejch kodu (proc popisovat to co si prectu sam kdyz se podivam na kod)... kazdoapdne uplne bez komentaru se to neobejde

13. 12. 2011 00:07:27

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706049

Tomáš Burda

(1 hodnocení)

16. 12. 2011 20:54:42

Snažím se mít u každé třidy základní popis a pak anotace. V kombinaci s dobrým ide to hodně ulehčí práci. Případně nějaké složitější algoritmy i po krocích, ale to jsou vyjímky. Nepsat žádný komentář je slušně řečeno bejkárna.

vedouci S tím souhlasím nejhorší je špatný komentář (nejčastěji nějaké copy+paste a "pak se to přepíše" :))

16. 12. 2011 20:54:42

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare/strana/2#reply706048