Com\’è dura la professione!

7 agosto 2006

Un commento di troppo

Filed under: Programmazione — lbell @ 20:59

Java e C# riuniscono dichiarazioni ed implementazione per semplificare la gestione dei programmi. Si può semplificare anche la gestione della documentazione inserendola direttamente nel sorgente ed estraendola con appositi strumenti (Javadoc, Ndoc). I metodi degli oggetti possono essere preceduti da un commento codificato che ne descrive la funzione ed i parametri attraverso una particolare notazione. Scrivere i commenti così lontano dagli oggetti cui sono riferiti ci riporta però alla situazione che abbiamo voluto evitare per il codice, cioè occorre uno sforzo in più per tenere allineati documentazione e codice.

Quando le scadenze di consegna dei programmi incombono ed il codice si deve modificare velocemente, i commenti scritti in cima alle funzioni tendono a non essere più così visibili e fatalmente li si trascura. Un volta che il programma ( o la correzione ) è stato messo in produzione, i sorgenti non si modificano, nemmeno per completare i commenti.

Proviamo ora a compilare una classe di esempio in C# in cui abbiamo tralasciato qualche dichiarazione. Il compilatore si lamenta un po’, ma senza seccarci troppo.

 
         ///<summary>
         /// questo e' il sommario
         /// <c> codice</c>
         /// <param name="uno\">prova uno</param>
         /// <param name="due\">prova due</param>
         /// <RETURNS>spiegazione del valore di ritorno</RETURNS>
         ///</summary>         public int somma2( int quattro )
         {
                 return quattro+2;
         }

Non si potrebbe invece utilizzare una notazione che pretenda che il commento sia effettivamente legato al parametro stesso, come mostrato nel metodo scritto qui sotto (con una notazione di fantasia)?

 
        public int  somma	/*= esegue questo e quello */
        (         int uno	/*= serve a fare questo */,
                 int due	/*= serve a fare quello */ )
        {
                 return uno+due;
 	}

E’ ora più difficile che codice e commenti siamo disallineati.

Il corpo della documentazione inserito nei commenti può contenere link ad altre parti di programma, parti in grassetto e così via, il tutto utilizzando una sintassi HTML like. Non sarebbe male, tanto per praticità, che fosse l’IDE ad occuparsi di questi dettagli, formattando questa parte di codice come se fosse un piccolo word processor; certo l’IDE non sarebbe più un semplice editor di testi, ma è da tempo che in realtà non lo è più. Nulla impedisce che utilizzando invece un editor come vim, il codice in HTML like ricompaia.

1 commento »

  1. properti

    Un commento di troppo | Com\’è dura la professione!

    Trackback di properti — 29 agosto 2015 @ 4:17 | Rispondi


RSS feed for comments on this post. TrackBack URI

Lascia un commento

Inserisci i tuoi dati qui sotto o clicca su un'icona per effettuare l'accesso:

Logo WordPress.com

Stai commentando usando il tuo account WordPress.com. Chiudi sessione / Modifica )

Foto Twitter

Stai commentando usando il tuo account Twitter. Chiudi sessione / Modifica )

Foto di Facebook

Stai commentando usando il tuo account Facebook. Chiudi sessione / Modifica )

Google+ photo

Stai commentando usando il tuo account Google+. Chiudi sessione / Modifica )

Connessione a %s...

Blog su WordPress.com.

%d blogger cliccano Mi Piace per questo: