Commentare il codice sorgente, è inutile?
giovedì, settembre 24, 2009 12:37 scritto da neryoSul sito phpnews.it ho letto questo post che cita altri siti/blog internazionali sull’argomento dell’utilità o meno di commentare il codice sorgente delle applicazioni. Il mio punto di vista in merito è che la cosa fondamentale quanto di scrive del codice è rendere semantica ogni istruzione, che tradotto significa dare nomi più sensati alle alle classi/metodi/proprietà e variabili che si utilizzano. Questa pratica permette di dare più senso ad ogni riga di codice e rende già tutto molto più chiaro a chi lo deve interpretare.
I commenti comunque possono essere utili e in certi rari casi sono fondamentali, soprattutto in procedure complesse e ricche di casistiche.. ma se si abusa si hanno sostanzialmente due svantaggi: 1) si perde tempo 2) non serve a niente o quasi a nulla.
Inutile quindi fare commenti su parti di codice poco complessi che sono già autoesplicativi, porzioni di codice che qualsiasi programmatore junior è in grado di leggere. Piuttosto fare molta attenzione alla strutturazione del codice, che come già da tempo ci insegnano i grandi sviluppatori e web architects moderni, per il web tende sempre all’architettura in stile MVC, che è quella che si avvicina di più alla logica di internet… questo semplica notevolmente la stesura, la manutenzione e la comprensione del codice scritto, oltre a rendere i moduli che compongono l’applicazione indipendenti e incapsulati.
Per le applicazioni software tradizionali invece apprezzo molto l’approcio code behind, business logic e data access layer
Quindi non abusare mai di commenti, usare nomi sensati e fate attenzione piuttosto all’architettura del software.. chiaramente object oriented!
In attesa di un vostro parere in merito… 
(1 voti, media: 4,00 di 5)
Loading ...
Lorenzo dice:
24-09-2009 alle 13:57
Bah ci insegnano sempre a noi programmatori che il codice va commentato. Ed io sono d’accordo con questa politica, senza però esagerare ma inserendo i giusti commenti che spiegano a grandi linee cosa si sta cercando di fare.
Ritengo questo comportamento molto utile, sia nel caso in cui il codice finisca in mani di terzi diverse da quelle dell’autore, sia nel caso in cui l’autore stesso abbia la necessità di rimaneggiare il codice dopo molto tempo, magari anche dopo qualche anno.
Credo che serva molto commentare. E non porta via tempo se mentre scrivi il codice aggiungi una riga dove spiega cosa fa.
Lino dice:
10-10-2009 alle 18:37
Io penso che commentare il codice per favorire gli altri sia una bella cazzata.. in una logica Open Source forse.. ma lo scenario di un programmatore non è sempre open source, anzi.. Io non commento niente, anzi, cerco di incasinare tutto il più possibile, così se c’è necessità di modifiche al progetto i soldi li prndo io prendo io, perchè un’altro non ci capirebbe nulla..
Lorenzo dice:
11-10-2009 alle 11:30
Bah, se fai così, spero proprio di non lavorare mai con te in un progetto!
Altrimenti sarebbe davvero complicato capire quel che vuoi fare senza nemmeno una riga di commento.
Per me commentare il codice nn è importante solo in un contesto open source ma anche in un progetto in cui siamo più collaboratori, più programmatori insieme: anche per un passaggio d consegne diviene tutto molto più facile se il codice scritto è chiaro e lineare.
Non sei d’accordo?
Namaless dice:
29-11-2009 alle 01:07
Ritengo che commentare il codice sorgente sia importante, quanto meno rispettare lo standard qualora si decide di utilizzare dei sistemi automatizzati per trarre delle sotto-specie di documentazione (vedi phpDoc).
Per quanto riguarda lo sviluppo in team ritengo che siano obbligatori come suggeriva appunto Lorenzo. Per applicazioni sviluppate e mantenute da me lo commento ugualmente in quanto passato del tempo devi rileggere ogni metodo, invece con i commenti messi al posto giusto non hai necessità.
Io comunque per comprendere meglio il codice mi scrivo di solito delle mini-libs che mi permettono di ricordare cosa fanno, del tipo Session::flash() oppure Pagination::factory(), ecc…
Cesare dice:
16-04-2010 alle 10:09
Ottimi consigli, aggiungo che talvolta troppi commenti rendono anche meno leggibile il codice per via delle continue interruzioni!
PS: questo blog è molto interessante, è già entrato nei miei segnalibri