Commenti nel codice

5.1 Come scrivere commenti

In Python, come in molti linguaggi di programmazione, puoi scrivere commenti nel codice. I commenti aiutano i programmatori e altri membri del progetto a comprendere il codice, il che è particolarmente utile quando si lavora in team e quando si deve mantenere il software nel lungo termine. In Python esistono diversi modi per aggiungere commenti al codice.

Commenti su una sola riga:

Iniziano con il simbolo #. Tutto ciò che segue # nella stessa riga viene ignorato da Python. Questo tipo di commento è solitamente utilizzato per brevi annotazioni o spiegazioni su una particolare riga di codice. Esempio:

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

Commenti multilinea:

In Python ufficialmente non esiste una sintassi speciale per i commenti multilina, ma si possono creare tramite diversi commenti su singola riga o utilizzare le triple virgolette, anche se queste ultime sono in realtà letterali stringhe multilina che non vengono eseguite come codice. Esempio:

# Questo è un esempio di commento multilina # Ogni riga inizia con il simbolo #
      

oppure:

""" Questo è un letterale stringa multilina che può essere usato come commento. Python lo interpreta come una stringa, ma non fa nulla con essa, a meno che non venga assegnata a una variabile o utilizzata in un'espressione. """ 
      

5.2 Perché scrivere commenti

L'uso dei commenti nel codice ne migliora la leggibilità, facilita la manutenzione e gli aggiornamenti, e contribuisce a una collaborazione più efficace nei team. I commenti devono essere concisi, ma informativi e rilevanti, per servire come utile documentazione del codice senza appesantirlo con informazioni superflue.

Docstring:

Sono stringhe che di solito si trovano all'inizio di moduli, classi, metodi e funzioni per descriverne lo scopo. Sono racchiusi tra triple virgolette doppie e possono essere usati per la generazione automatica della 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, a volte gli sviluppatori aggiungono commenti al loro codice che non solo servono come spiegazioni, ma fanno anche sorridere. Ecco alcuni esempi di commenti divertenti che puoi trovare nel codice:

Esempio 1

 

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

Esempio 2

 

    # Se non funziona, è 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 funzionava.
    # Ora lo sa solo Dio.

Questi commenti possono aggiungere leggerezza e umorismo al processo di sviluppo, rendendo la base di codice meno monotona. Possono anche ricordarci che lo sviluppo software è un processo creativo e umano.

5.3 Commentare rapidamente il codice

In PyCharm, puoi commentare o decommentare rapidamente il codice utilizzando le scorciatoie da tastiera. Per fare ciò, seleziona le righe di codice che vuoi modificare 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 il processo rapido ed efficiente.