Programmazione Java - Lez 3 : I Commenti

Quando si scrive un programma troppo lungo, ma anche programmi più piccoli sopratutto per chi inizia, è consuetudine scrivere commenti che identificano dove siamo arrivati col programma, cosa fa quell'istruzione e così via.
Esistono 3 tipi di commenti:
1. Commento su riga (piccolo)
2. Commento su più righe (grande)
3. Commento di documentazione

Il primo viene scritto su un'unica riga e va scritto con un doppio slash "//".
Questo non va chiuso, in quanto il compilatore già sa che il commento è su un'unica riga.
Ecco un esempio:

public class Prova {
   public static void main(String[] args) {
       // Sto stampando ciao mondo
       System.out.println("Ciao mondo");
   }
}

Il secondo, serve quando bisogna scrivere un commento più lungo che occupi più di una linea.
Potremmo scriverlo anche su un'unica linea ma così è più diffiicile da leggere, in quanto dovremmo spostarci per leggere tutto il commento.
In questo caso non usiamo il doppio slash, ma uno slash seguito da un asterisco "/*".
Fatto questo possiamo scrivere un commento più lungo, ma dato che non è su unica riga quando sappiamo che il nostro commento è finito, e che da quel momento in poi il programma deve continuare ad essere eseguito?!?
Niente di più semplice, basta mettere un '*/' per indicare che il commento è finito.
Esempio:

public class Prova {
   public static void main(String[] args) {
       /* Questo è un
         commento più lungo */
       System.out.println("Ciao mondo");
   }
}

Il terzo ed ultimo commento serve per informare la persona che sta guardando il vostro codice a capire qualcosina in più. Serve ad informarla su chi è l'autore, informa quale è la versione, dice quale documentazione guardare prima di leggere il codice e così via. Va inserito, infatti, prima di dichiarare la classe.
Esempio:

/**
  @author Gdg92ct
  @see prova2
  @version 1.0
*/
public class Prova {
   public static void main(String[] args) {
       /* Questo è un
         commento più lungo */
       System.out.println("Ciao mondo");
   }
}

 Qui dice autore Giovanni Di Gregorio, prima di leggere la classe leggere prova 2, e che la versione è la 1.0

Preucazione
È consuetudine tra i programmatori isolare una parte di codice che non si intende eseguire momentaneamente inglobandolo tra comandi di commento. Questo non è auspicabile perché la sintassi di Java non consente annidamento di commenti del tipo lungo.
Errore comune:

public static void main(String[] args) { /* Questo è un /* commento 2 */ commento più lungo */ System.out.println("Ciao mondo"); }

In questo caso abbiamo un errore in quanto il primo */ fa finire il commento! e la stringa:

commento più lungo */


Non viene vista come commento ma come istruzione, e dato che non esiste un istruzione del genere quando compilate il programma vi da errore. Se vedete, anche qui non viene evidenziato in verde in quanto non viene riconosciuto come commento.

Aggiungi un commento

Plain text

  • Nessun tag HTML consentito.
  • Indirizzi web o e-mail vengono trasformati in link automaticamente
  • Linee e paragrafi vanno a capo automaticamente.
CAPTCHA
Questa domanda serve a verificare se sei un visitatore umano e per prevenire spam.