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

9. 12. 2011 22:05:13

V poslednom čase ma dosť trápi otázka, či písať alebo nepísať komentáre v zdrojovom kóde. Aký je Váš názor? Kedy a či vôbec sú komentáre podľa Vás vhodné? Aký by mal byť správny komentár?

9. 12. 2011 22:05:13

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706072

Netagent

9. 12. 2011 22:09:30

Pro pozdější dobrou orientaci v kódu určitě ANO.

9. 12. 2011 22:09:30

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706071

DX632

(3 hodnocení)

9. 12. 2011 22:13:28

Sám musíš vědět, kdy je pro tebe kód dostatečně přehledný, aby ses v něm i s odstupem času orientoval.

Pokud zdrojový kód aplikace předáváš, pak je vhodné psát komentáře VŽDY a VŠUDE.

9. 12. 2011 22:13:28

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706070

Tkim

(49 hodnocení)

9. 12. 2011 22:14:00

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. Pokud pro sebe ta určitě ano ! Přece ty budeš pak hledat ...

9. 12. 2011 22:14:00

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706069

FSP

(1 hodnocení)

9. 12. 2011 22:19:19

Určite áno. Mne sa to oplatilo keď som si začal komentovať 1000 riadkové CSS súbory.

9. 12. 2011 22:19:19

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706068

Smazaný účet m5u2DKRief

(48 hodnocení)

9. 12. 2011 22:22:18

Napsal Tkim;731817
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

Byl by leda za idiota a potrestal jen sebe, jelikož by mu firma právem neudělala pěknou referenci. Komentáře se píší právě pro tyto případy a nemusí jít o opuštění firmy, ale třeba jen přesedlání na jiný projekt či pozici. V kódu by se zkrátka měl vždy vyznat i úplně cizí člověk, pak je to skvělá vizitka.

9. 12. 2011 22:22:18

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706067

TT Media s.r.o

(1 hodnocení)

9. 12. 2011 22:45:20

Jednoznacne ne do kodu ale do samotneho souboru ktery si nechas u sebe pokud si to zakaznik primo nevyzada ...

---------- Příspěvek doplněn 09.12.2011 v 22:45 ----------

rika se tomu technicka dokumentace :)

9. 12. 2011 22:45:20

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706066

DX632

(3 hodnocení)

9. 12. 2011 23:09:22

T&T Media s.r.o: Už se vidím, jak po někom upravuji kód o 10 000 řádcích, na jednom monitoru mám otevřenou technickou dokumentaci a na druhém kód :))

Technická dokumentace je samozřejmě v pořádku, tam si najdu kde funkce je a co dělá. Při samotné editaci už ale spoléhám na komentáře.

Jak psal Ondřej, kód je tvoje vizitka a komentáře k němu patří.

9. 12. 2011 23:09:22

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706065

qwertr

(7 hodnocení)

9. 12. 2011 23:13:43

No neviem. McConnell v knihe dokonaly kod dokonca hovori o pisani v pseudokode. Nieco v tym vyzname, ze si najprv popises co ides robit slovne a potom to do toho doprogramujes a ten popis sa stava komentarom.

Moj nazor je urcite komentovat. X razi som potreboval doplnit alebo opravit kod ktory pisal kolege a on bol mimo a poviem ti, je rozdiel sa orientovat v kode, ktory je dobre komentovany a ktory je bez komentarov.

9. 12. 2011 23:13:43

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706064

Tomáš Zíma

(6 hodnocení)

9. 12. 2011 23:15:29

Komentáře psát rozhodně vždy a všude. Je vhodné komentovat např. co dělá která funkce, třída, metoda apod., protože ti stačí přečíst třeba jednu větu místo kusu kódu. Nemá smysl to přehánět a komentovat každý řádek (s výjimkou speciálních případů), ale komentovat určité bloky pro rychlejší orientaci je podle mě naprostý základ.

---------- Příspěvek doplněn 09.12.2011 v 23:18 ----------

Dalo by se to trochu přirovnat k psaní nadpisů. Text taky občas nechcete číst celý, ale potřebujete se v něm rychle zorientovat..

9. 12. 2011 23:15:29

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706063

Thomasxx

(5 hodnocení)

9. 12. 2011 23:27:18

Já jsem určitě za komentáře vděčný, když pracuji s nějakým cizím kódem, takže používat :) Ale jestli to máš jen pro sebe, tak záleží na tobě..

9. 12. 2011 23:27:18

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706062

Jirka

(74 hodnocení)

9. 12. 2011 23:55:54

Při správným vývoji kódu aplikace vznikne komentář sám dokumentací procesu vývoje viz třeba uml, pokud děláš vývoj z hlavy komentář se hodí i pro sebe sama - přece si nebudeš pamatovat co jsi kdy napsal stroji aby to provedl...

9. 12. 2011 23:55:54

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706061

(20 hodnocení)

10. 12. 2011 00:36:37

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

10. 12. 2011 00:36:37

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706060

800XE

(8 hodnocení)

10. 12. 2011 01:01:50

Komentáře určitě piš. Taky jsem se na to na začátku díval trochu jako na zbytečnost, ale teď mi komentáře tvoří tak třetinu kódu. Když se ke kódu vrátíš po delší době, tak budeš opravdu rád, že se máš čeho chytnout na první pohled, aniž bys to musel všechno louskat znova. To ani nemluvím o cizích kódech, tam to bývá k nezaplacení. Samozřejmě nemusíš komentovat každou blbost jako sčítání 1 + 1, ale potenciálně hůř srozumitelný kód by měl být okomentovaný vždycky.

10. 12. 2011 01:01:50

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706059

Tomáš Zíma

(6 hodnocení)

10. 12. 2011 01:11:43

800XE: Tvůj nick mi z nějakého důvodu připoměl Assembler. Tak mě napadlo, jak by vypadal nekomentovaný kód v něm :-). Na druhou stranu už se používá opravdu jen v naprosto speciálních případech (jádra OS, ovladače, programování pro zvláštní zařízení, ...).

10. 12. 2011 01:11:43

https://webtrh.cz/diskuse/pisat-alebo-nepisat-komentare#reply706058