Commenti in Python

1. Come scrivere commenti

In Python, come in molti altri linguaggi di programmazione, è possibile scrivere commenti nel codice.

I commenti sono semplicemente testo per altri programmatori: l'interprete Python non li considera e non esegue il codice scritto al loro interno. I commenti aiutano i programmatori e altri membri del progetto a capire il codice, il che è particolarmente utile per progetti collaborativi e per la manutenzione a lungo termine del software. In Python ci sono diversi modi per aggiungere commenti al codice.

Commenti su una sola riga:

Iniziano con il simbolo #. Tutto ciò che segue il simbolo # nella stessa riga viene ignorato dall'interprete Python. Questo tipo di commento è solitamente utilizzato per brevi osservazioni o spiegazioni in una determinata riga del codice. Esempio:

# Questo è un commento su una sola riga
print("Hello, World!")  # Spiegazione dell'azione della funzione

Commenti su più righe:

In Python non esiste ufficialmente una sintassi speciale per i commenti su più righe, ma possono essere creati utilizzando più commenti su una sola riga o usando le triple virgolette, anche se queste ultime sono in realtà letterali string multilinea, che non vengono interpretati come codice. Esempio:

# Questo è un esempio di commento su più righe
# Ogni riga inizia con il simbolo `#`

o:

"""
Questo è un letterale multilinea che può essere utilizzato come commento.
Python lo interpreta come una stringa, ma non ci fa nulla,
se non viene assegnato a una variabile o utilizzato in un'espressione.
"""

Utile! Un letterale è un piccolo pezzo di dati scritto direttamente nel codice: un numero, una stringa, e così via.

2. Perché scrivere commenti

L'uso dei commenti nel codice migliora la leggibilità, facilita la manutenzione e l'aggiornamento, e favorisce una collaborazione più efficace nei team. I commenti devono essere brevi, ma informativi e pertinenti, in modo da servire come una documentazione utile del codice senza riempirlo di informazioni superflue.

Stringhe di documentazione (docstrings):

Sono stringhe multilinea che di solito si trovano all'inizio di moduli, classi, metodi e funzioni per descriverne lo scopo. Sono racchiuse in tre coppie di virgolette doppie e vengono utilizzate per generare automaticamente la documentazione.

Esempio:

def add(a, b):
    """
    Funzione per sommare due numeri.
    :param a: primo addendo
    :param b: secondo addendo
    :return: somma di a e b
    """
    return a + b

Nel mondo della programmazione, gli sviluppatori a volte includono nei loro codici commenti che non solo servono come spiegazioni, ma portano anche un sorriso. Ecco alcuni esempi di commenti divertenti che si possono trovare nel codice:

Esempio 1:

# Spiegherei cosa succede qui, ma nemmeno io lo capisco più.

Esempio 2:

# Se non funziona, la colpa è di qualcun altro.

Esempio 3:

# Sono venuto, ho visto, ho corretto... e ho rotto tutto.

Esempio 4:

# Quando ho scritto questo, solo io e Dio sapevamo come funziona.
# Ora lo sa solo Dio.

Esempio 5:

# Ore perse inutilmente qui = 42.

Questi commenti possono aggiungere leggerezza e umorismo al processo di sviluppo, rendendo il codice meno monotono. Ricordano anche che lo sviluppo software è un processo creativo e umano.

5.3 Commentare rapidamente il codice

Nell'IDE PyCharm puoi commentare o de-commentare rapidamente il codice, utilizzando le scorciatoie da tastiera. Per farlo, seleziona le righe di codice che vuoi commentare o de-commentare, e premi Ctrl + / su Windows (o Cmd + / su macOS). Questa combinazione di tasti aggiunge o rimuove il simbolo di commento su ogni riga selezionata, rendendo questo processo rapido ed efficiente.