Dokumentace kodu

[Milan B.]

On 18. 6. 2015 18:52, Michal Gregor wrote:
> No v jedne knizce se pise:
> "Dobre napsany kod nepotrebuje komentare."

Co je treba chapat v spravnom kontexte a nie ako vyhovorku pre lenivych 
programatorov.

Dobre napisany kod (program) nepotrebuje komentare na vysvetlenie, co 
robi ta-ktora programova konstrukcia. To by malo byt jasne z nej.

Takze dobry kod je jasny (testujem najvyssi bit):

unsigned char x;
...
if ( x & 0x80 )
...

zatial co zly kod potrebuje komentar:

unsigned char x;
...
if ( x > 127)   // test, ci je nastaveny najvyssi bit
...

Ale samozrejme komentar, co ten najvyssi bit je a pripadne preco sa 
testuje bude urcite vhodny.

-m-