Commenti

A cosa servono i commenti?

Immagina di tornare a leggere un codice che hai scritto sei mesi fa. Senza commenti, potresti non capire più cosa fa o perché lo hai scritto in quel modo.

I commenti sono note che scrivi nel codice per spiegare cosa sta succedendo. Il compilatore le ignora completamente: esistono solo per chi legge il codice (tu, un compagno, un professore).

Scrivere buoni commenti è un’abitudine che distingue un programmatore attento da uno frettoloso.

Commento su riga singola: //

Il commento su riga singola inizia con //. Tutto ciò che viene dopo //, fino alla fine della riga, viene ignorato dal compilatore.

// Questo intero commento viene ignorato
int x = 5; // anche questo, solo la parte dopo //

// Puoi usare i commenti per disabilitare temporaneamente una riga
// int y = 10;  ← questa riga non viene eseguita

Commento su più righe: /* ... */

Il commento su più righe inizia con /* e finisce con */. Tutto ciò che sta in mezzo viene ignorato, anche se occupa più righe.

/* Questo è un commento
   che occupa più righe.
   Utile per spiegazioni lunghe. */

int x = 5;

/*
 * Alcuni programmatori aggiungono un asterisco
 * all'inizio di ogni riga per migliorare la leggibilità.
 * È solo una convenzione stilistica.
 */

Cosa commentare: il “perché”, non il “cosa”

Un buon commento spiega perché fai qualcosa, non cosa stai facendo. Il codice stesso dovrebbe essere abbastanza chiaro da spiegare il “cosa”.

// Commento inutile — il codice si capisce già da solo
x = x + 1; // incrementa x di 1

// Commento utile — spiega il motivo
tentativi = tentativi + 1; // blocchiamo l'accesso dopo 3 tentativi falliti

Documentare le funzioni

Usa i commenti per spiegare cosa fa una funzione, i valori che riceve e quello che restituisce:

// Calcola l'area di un rettangolo.
// base: la larghezza del rettangolo (in centimetri)
// altezza: l'altezza del rettangolo (in centimetri)
// Restituisce l'area come numero decimale.
double calcolaArea(double base, double altezza) {
    return base * altezza;
}

Chi usa questa funzione capisce subito come usarla, senza dover leggere il codice al suo interno.

Disabilitare codice temporaneamente

Durante il debug, puoi commentare del codice per escluderlo momentaneamente dall’esecuzione:

int main() {
    int x = 10;
    // cout << "Valore intermedio: " << x << endl;  ← disabilitato per ora
    cout << "Valore finale: " << x << endl;
    return 0;
}

Questo è più veloce che cancellare il codice e poi riscriverlo.

Commenti da evitare

Evita i commenti che non aggiungono alcuna informazione rispetto al codice:

// Da evitare — sono ovvi
int eta = 16;    // imposta eta a 16
x = x + 1;      // aggiunge 1 a x
return 0;        // ritorna 0

Evita anche i commenti sbagliati, cioè che non corrispondono più al codice. Sono peggio di nessun commento, perché ingannano chi legge:

// Somma due numeri  ← SBAGLIATO! In realtà moltiplica
int risultato = a * b;

Esempio completo

#include <iostream>
using namespace std;

/*
 * Programma: Calcolatore dell'area di un cerchio
 * Autore: Alice
 *
 * Legge il raggio dall'utente e calcola l'area.
 */

// Valore approssimato di pi greco — non cambia mai
const double PI = 3.14159265358979;

int main() {
    double raggio;

    // Chiediamo il raggio all'utente
    cout << "Inserisci il raggio: ";
    cin >> raggio;

    // Calcoliamo l'area con la formula: A = pi * r²
    double area = PI * raggio * raggio;

    cout << "L'area del cerchio è: " << area << endl;

    return 0;
}