Quanto é importante il commento del codice?

[ElBebo]

Buona sera a tutti! Ho da poco iniziato a pensare sarebbe meglio commentare il mio codice, ma mi sono solo sommerso di domande. Prima tra tutte: quanto é importante il commento? Come si scrive un buon commento e quando? Cosa ne pensate?

[Wolfrost]

È fondamentale, ancora di più se non sei l'unico che ci lavora sopra.
È buona prassi commentare, nè poco, nè troppo, il giusto.

Commentare in modo decente, ti aiuterà a capire velocemente cosa fà un pezzo di codice anche dopo mesi che non ci metti le mani sopra.

Quoto

[tola22]

é vero io ne sto subendo le conseguenze.. ho un progetto fermo da qualche settimana e gia faccio fatica a capire quello che ho fatto anche perché é un lavoro abbastanza grandicello...
ora infatti sto lavorando ad un secondo progetto e per evitare queste cose ho iniziato anche io a commentare i miei codici.
é la miglior cosa.

[Solid Snake]

E' molto importante saper commentare bene il codice, personalmente non metto un commento ogni linea, solo in quelle istruzione che possono essere più complicate delle altre. Oppure commento direttamente una porzione di codice in modo da capire subito che cosa fa.

[Breston]

Confermo, commentare è fondamentale per qualunque progetto. Richiede il suo tempo ma se fatto bene porta una serie di benefici per la comprensibilità, la mantenibilità e l'organicità del codice.
Per scrivere dei buoni commenti come prima cosa è importante essere coerenti. Stabilisci delle regole e rispettale, non deve essere una scrittura creativa. Per esempio per ogni funzione potresti inserire nome - parametri - ritorno - descrizione - esempio.
All'interno del corpo di una funzione io faccio in modo di evidenziare i "task" principali del codice, che divido visivamente attraverso i commenti. Questi vengono a loro volta suddivisi in task secondari, solitamente della lunghezza di 5 - 20 righe di codice. Ognuno è anticipato da una riga o due di commenti che spiegano cosa fa il codice che segue.