Commenti nel codice sorgente del software?

clipped from i165.photobucket.com clipped from jasonmbaker.com Myths about code comments Comments are free When you update the code that the comment references, you usually have to update the comment as well. Comments make code more readable Comments don't make code more readable. They are ways to compensate for code not being readable. You should comment every function, method, class, and module How many times have you seen docstrings like this? def get_x(self):     This method gets x.    Code must always be "self documenting" would you rather use a one-liner that requires a 3-line comment, or a 10-liner that requires no comments?

Sfatiamo cinque miti sui commenti.

1) non è vero che non costano niente... quando modifichi il sorgente, devi modificare di solito anche i commenti.

2) non è vero che rendono il codice più leggibile... di solito vengono usati proprio perché il codice era illeggibile!

3) la mania di commentare ogni funzione e modulo porta a commenti stupidissimi e inutili.

4) è meglio avere 10 righe di codice che si capiscono subito, oppure tre righe di codice astruso ma "documentato"?