Commenti in Python

Perché scrivere commenti?

Se riapri dopo sei mesi un quaderno pieno solo di formule e numeri, potresti non ricordare più cosa significano.

Nel codice succede qualcosa di simile. Un commento è una nota per spiegare una scelta o un passaggio. Python lo ignora quando esegue il programma.

Un buon commento aiuta chi leggerà il codice in seguito, compreso te stesso.

Commenti su una riga

In Python, un commento inizia con il simbolo #. Tutto quello che viene scritto dopo # sulla stessa riga viene ignorato da Python:

# Questo è un commento: Python lo ignora completamente
print("Ciao!")  # Puoi mettere un commento anche dopo il codice

# Puoi usare i commenti per "disattivare" del codice temporaneamente:
# print("Questa riga non viene eseguita")

Note su più righe

Per scrivere un commento su più righe, metti # all’inizio di ogni riga:

# Questo programma calcola l'area di un rettangolo.
# Prende la base e l'altezza come input
# e stampa il risultato.

Le virgolette triple, invece, creano una stringa su più righe: non sono una seconda sintassi per i commenti. Quando quella stringa si trova all’inizio di un modulo, di una funzione o di una classe, può diventare una docstring, cioè documentazione accessibile anche dal programma.

Cosa scrivere (e cosa NON scrivere)

Un buon commento spiega il perché di una scelta, non il cosa che il codice rende già evidente.

# Male: il commento dice l'ovvio, non aggiunge nulla
x = 10  # assegna 10 a x

# Bene: spiega perché usiamo quel numero specifico
VELOCITA_MASSIMA = 130  # limite autostradale in Italia, in km/h

# Bene: spiega una formula non ovvia
area = 3.14159 * raggio ** 2  # formula del cerchio: pi * r²

Le docstring: commenti per le funzioni

Le docstring sono stringhe speciali inserite all’inizio di una funzione o di una classe per descriverne lo scopo. Si scrivono con le virgolette triple:

def calcola_area(base, altezza):
    """Calcola e restituisce l'area di un rettangolo."""
    return base * altezza

def saluta(nome):
    """
    Stampa un messaggio di benvenuto personalizzato.

    Parametri:
    - nome: il nome della persona da salutare
    """
    print("Ciao, " + nome + "!")

Le docstring sono utili anche perché puoi leggerle dal programma stesso con la funzione help():

help(calcola_area)
# Stampa: Calcola e restituisce l'area di un rettangolo.