Lezioni di Python – 3.5 Commenti e Docstrings

Commenti

Quando si scrive un codice di programmazione è sempre importante aggiungere delle annotazioni per rendere più comprensibile quello che si è scritto, non solo per gli altri, ma anche per se stessi.

Nel linguaggio Python i commenti si identificano inserendo un segno # (sharp) all’inizio della riga. Tutto il testo che verrà scritto in seguito a questo carattere sarà un commento e non verrà considerato in fase di esecuzione.

Quindi i commenti aumentano la leggibilità del codice e sono una prerogativa per la stesura di un buon codice.

# Questo è un commento
i = 1 # Ma anche questo è un commento

Spesso i commenti sono molto utili anche in fase di dedug, mettendo sotto forma di commento alcune righe di codice, eliminandole dall’esecuzione ma solo temporaneamente, in modo da non dimenticarle e da poterle riattivare in un attimo cancellando il carattere #.

Docstrings

Esiste un’altro metodo che permette di aggiungere alcune righe di testo al codice ed evitare che venga considerato durante l’esecuzione del programma. Questo metodo si basa sulle docstrings, caratterizzate da righe di testo racchiusa tra “”” e “”” (una tripletta di doppi apici).

In realtà le docstrings non sono nate per scrivere commenti nel codice, bensì per dare delle spiegazioni. Permettono infatti di poter aggiungere più righe di testo al codice, e generalmente vengono inserite all’inizio di un programma o all’inizio di una funzione per spiegarne il funzionamento.

def foo():
"""
Questa funzione serve solo per dare
una spiegazione su come si usano le docstrings
"""

Attenzione a differenza dei commenti, le docstrings, anche se non eseguite, vengono in realtà immagazzinate a runtime e possono essere richiamate se uno lo desidera, con l’attributo __doc__

print(foo.__doc__)
>>>

Questa funzione serve solo per dare una spiegazione su come si usano le docstrings

⇐ Vai a Lezione 3.4 – Valori restituiti dalle funzioni

Vai a Lezione 3.6 – Funzioni come oggetti ⇒