  |
I commenti nei programmi Java: |
Iniziamo il corso vedendo come inserire all'interno di un programma
Java del testo descrittivo che strettamente non è un programma.
/* commento */
  |
I caratteri compresi tra /* e */ sono
ignorati. |
La forma più semplice di commento è quella che inizia con una
barra seguita da un asterisco; poi segue il testo di commento, che
infine viene terminato con un asterisco seguito da una barra. Questo
tipo di commento si può estendere per varie righe di codice. Posso
cominciare un commento in una riga e finirlo dieci riga più avanti.
// comment
  |
Tutti i caratteri successivi a // fino a fine linea sono
ignorati. |
Questo tipo di commento è però scomoda da scrivere per il fatto
che si devono sempre inserire due caratteri alla fine. Molto spesso si
vuole semplicemente inserire rapidamente un'annotazione ad una riga di
codice. Per questo motivo esiste un tipo di commento che inizia
semplicemente con due barra e viene terminato alla fine riga.
/** comment */
  |
Come /* */, ma viene usato per la documentazione |
  |
Il commento viene usato con il tool javadoc |
  |
Creare automaticamente la documentazione dai sorgenti . |
Un altro importante tipo di commento presente in Java, è simile a
quello iniziale, ma inizia con due asterischi invece che di uno. In
realtà si tratta semplicemente del primo tipo di commento, solo che
quando ci sono due asterischi, un programma particolare chiamato
javadoc è in grado di interpretare questi commenti, e trasformarli
in pagine HTML, che servono a produrre della documentazione
direttamente dai sorgenti del codice. La documentazione standard di
Java è prodotta utilizzando questo strumento.
|