Zadejte hledaný výraz...

Jak psát komentáře, aby byly kompatibilní mezi programátory?

AlaM
verified
rating uzivatele
(4 hodnocení)
22. 12. 2017 11:15:25
Zdravím vás, existuje nějaká dokumentace jak psát správně komentáře, aby byli kompatibilní mezi programátory?
Díky za případný odkaz.
22. 12. 2017 11:15:25
https://webtrh.cz/diskuse/jak-psat-komentare-aby-byly-kompatibilni-mezi-programatory/#reply1318974
Prostě je dávej podle zaběhnutých pravidel, nejsou žádné striktní, nebo nejpoužívanější :-) Každý jazyk má své jasně dané a ty se používají.
22. 12. 2017 12:11:35
https://webtrh.cz/diskuse/jak-psat-komentare-aby-byly-kompatibilni-mezi-programatory/#reply1318973
vlnk
verified
rating uzivatele
(4 hodnocení)
22. 12. 2017 18:40:06
Clean Code
a) Nutnost komentovat kód je způsobena špatným návrhem nebo špatným programováním. :-)
b) S výhodou lze psát komentáře, ze kterých pak lze generovat dokumentaci (např. RDoc).
22. 12. 2017 18:40:06
https://webtrh.cz/diskuse/jak-psat-komentare-aby-byly-kompatibilni-mezi-programatory/#reply1318972
Pište komentáře anglicky
Dodržujte standard/úzus daného programovacího jazyka
Pomáhejte si vhodně zvolenými názvy
Popište, proč kód funguje zrovna takto. Nepopisujte, co dělá - to by mělo být čitelné přímo z kódu
Příliš mnoho i příliš málo komentářů je špatně
26. 12. 2017 08:28:24
https://webtrh.cz/diskuse/jak-psat-komentare-aby-byly-kompatibilni-mezi-programatory/#reply1318971
hm
verified
rating uzivatele
(20 hodnocení)
26. 12. 2017 09:53:57
Osobne se snazim kod psat tak aby byl Self-explanatory (takze radsi napisu delsi nazev promenne, funkce, tridy, ale hlavne ze je jasne co v ni ma byt a co dela) a vlastne v konentech jen dopisuju detaily kdyz to neni uplne jasne nebo chci vysvetlit proc sem to udelal zrovna takhle... Anglictina je nutnost, neni ni horsiho nez kdyz lidi pisou i kod cesky :D pro cesky rybnicek a male projekty mozna OK, ale jinak na zabiti...
26. 12. 2017 09:53:57
https://webtrh.cz/diskuse/jak-psat-komentare-aby-byly-kompatibilni-mezi-programatory/#reply1318970
Pro odpověď se přihlašte.
Přihlásit