Articolo originale: Python Multiline Comment – How to Comment Out Multiple Lines in Python

I commenti sono parte integrante di tutti i linguaggi di programmazione. Grazie ai commenti puoi comprendere meglio il tuo codice, renderlo più leggibile, e aiutare i membri del tuo team a capire meglio come funziona.

I commenti vengono ignorati dai compilatori e dagli interpreti, dunque non vengono eseguiti.

Oltre a rendere il tuo codice più leggibile, i commenti possono anche aiutare nella risoluzione degli errori (il debug) - se hai due righe di codice, puoi trasformarne una in un commento per evitare che venga eseguita.

Così come altri linguaggi di programmazione, Python supporta i commenti.

Il problema è che Python non ha un meccanismo integrato per i commenti multilinea.

Dunque in questo articolo non solo ti mostrerò come puoi scrivere commenti in Python su una riga singola - ti mostrerò anche l'espediente per scrivere commenti multilinea.

Come Scrivere Commenti su una Singola Riga in Python

Per scrivere commenti su una sola riga in Python, inizia ogni riga con un cancelletto (#).

# print("Hello world")

print("Hello campers")

Output:

Hello campers

Come puoi vedere, la riga di commento non è stata visualizzata nell'output.

Come Scrivere Commenti Multilinea in Python

A differenza di altri linguaggi di programmazione come JavaScript, Java, e C++ che usano /*...*/ per i commenti multilinea, non c'è nessun meccanismo integrato in Python per i commenti multilinea.

In Python, per trasformare in commenti più di una riga, puoi inserire un cancelletto (#) all'inizio di ogni riga.

# print("Hello world")
# print("Hello universe")
# print("Hello everyone")

print("Hello campers")

Output:

Hello campers

Con questo approccio, tecnicamente puoi scrivere molteplici commenti su righe singole.

L'espediente migliore per scrivere commenti multilinea in Python è usare le docstring.

Se usi una docstring per trasformare in commento molteplici righe di codice in Python, quel blocco di codice verrà ignorato, e solo le righe al di fuori della docstring saranno eseguite.

"""
Questo è un commento multilinea scritto usando le docstring

print("Hello world")
print("Hello universe")
print("Hello everyone")
"""

print("Hello campers")

Output:

Hello campers

NB: una cosa da notare è che, anche quando usiamo le docstring per scrivere commenti, l'indentazione è importante. Se non usi 4 spazi (o un tab) per l'indentazione, otterrai un'errore di indentazione.

Per esempio, questo funzionerà:

def addNumbers(num1, num2, num3):
    """
    Una funzione che restituisce la somma
    di tre numeri
    """
    return num1 + num2 + num3
print(addNumbers(2, 3, 4))

# Output: 9

Ma questo non funzionerà:

def addNumbers(num1, num2, num3):
"""
Una funzione che restituisce la somma
di tre numeri
"""
    return num1 + num2 + num3
print(addNumbers(2, 3, 4))

Per questo il tuo IDE restituirà l'errore "IndentationError: expected an indented block".

Conclusione

Poiché non c'è nessun supporto integrato per i commenti multilinea in Python, questo articolo mostra in che modo usare le docstring come espediente.

In ogni caso, dovresti continuare a usare i commenti regolari di Python con il cancelletto (#), anche se devi usarlo su più righe. Questo perché le docstring sono usate per la documentazione e non per trasformare le righe di codice in commenti.

Se hai trovato utile questo articolo, condividilo con la tua famiglia e i tuoi amici.

Grazie per aver letto.