Commenti

A cosa servono i commenti

Un commento è una nota scritta nel codice. Java la ignora durante l’esecuzione.

I commenti servono a spiegare un passaggio, lasciare un promemoria o chiarire un’intenzione.

// Salviamo il nome dell'utente
String nome = "Luca";

La riga che inizia con // non viene eseguita.

Commenti su una riga

Il commento più semplice inizia con // e continua fino alla fine della riga.

public class Esempio {
    public static void main(String[] args) {
        // Questo messaggio viene mostrato nel terminale
        System.out.println("Ciao!");
    }
}

Puoi usarlo anche alla fine di una riga:

int eta = 20; // eta dell'utente

Usalo con misura. Se il nome della variabile è già chiaro, il commento può essere inutile.

Commenti su più righe

Un commento su più righe inizia con /* e finisce con */.

/*
Questo programma calcola il totale
di un piccolo ordine.
*/
public class Totale {
    public static void main(String[] args) {
        double prezzo = 10.0;
        double spedizione = 3.5;
        System.out.println(prezzo + spedizione);
    }
}

È utile quando la nota è più lunga di una frase.

Commenti Javadoc

Java ha anche un tipo speciale di commento: il commento Javadoc.

Inizia con /** e finisce con */.

/**
 * Calcola il totale aggiungendo prezzo e spedizione.
 */
public static double calcolaTotale(double prezzo, double spedizione) {
    return prezzo + spedizione;
}

Questi commenti possono essere usati da strumenti automatici per generare documentazione.

All’inizio non devi usarli sempre. Ti basta sapere che esistono e che di solito descrivono classi e metodi.

Commenti buoni e commenti inutili

Un commento è utile quando spiega il perché di una scelta.

// Applichiamo lo sconto solo se il totale supera 50 euro
if (totale > 50) {
    totale = totale - 5;
}

Questo commento spiega una scelta che il codice da solo non mostra.

Questo invece aggiunge poco:

// Aumenta eta di 1
eta = eta + 1;

Il codice è già abbastanza chiaro.

Disattivare codice per provare

Durante gli esercizi puoi commentare una riga per non eseguirla temporaneamente:

System.out.println("Prima riga");
// System.out.println("Seconda riga");
System.out.println("Terza riga");

Output:

Prima riga
Terza riga

Suggerimento: va bene farlo mentre studi. Prima di considerare finito il programma, però, rimuovi il codice commentato che non serve più.