Commento
Un commento è una annotazione, che solitamente il programmatore inserisce all'interno del codice
di
un programma, allo scopo di rendere più agevole la lettura e comprensione del programma
stesso.
In java i commenti possono essere di tipo diverso e con funzionalità differenti.
Analizziamoli nel dettaglio:
- commento fino a fine riga, preceduto dalla
sequenza
di
caratteri //. Si tratta solitamente di un commento breve che
agisce
sul testo che segue lo slash doppio, fino al termine della riga; tale testo viene ignorato
dall'ambiente di sviluppo (IDE) e dal compilatore
// questo testo è un commento su riga singola
- commento multiriga, delimitato dalla sequenza di
caratteri /* (inizio commento) e */
(fine commento). Solitamente si utilizza per annotazioni un po' più consistenti, che
necessitano
di
più di una riga.
Il testo racchiuso tra i delimitatori di inizio e fine del commento, anche se su righe diverse, viene ignorato dall'ambiente di sviluppo (IDE) e dal compilatore/* questo testo è un commento che può occupare anche diverse righe */
- commento per la documentazione automatica delle
classi e
dei loro metodi pubblici, contenuti in un package,
prodotta attraverso lo strumento Javadoc, delimitato dalla sequenza di
caratteri /** (inizio commento) e */
(fine commento). Ogni riga è caratterizzata dal carattere *
seguito
dal testo descrittivo. Il testo
racchiuso tra i delimitatori di inizio e fine del commento, anche se su
righe diverse, viene ignorato dall'ambiente di sviluppo (IDE) e dal compilatore, ma viene
utilizzato
dal predetto
strumento, per la generazione di un documento HTML, che descrive le classi contenute
nel package ed i relativi metodi pubblici.
/** questo testo * è un commento speciale * utilizzato dallo strumento Javadoc * per generare un documento html descrittivo * del package/classe/metodo in cui è inserito */