Commenti In Python
Commenti in Python¶
Obiettivi della Lezione¶
Al termine di questa lezione, sarai in grado di:
- Comprendere l’importanza dei commenti nel codice Python.
- Utilizzare commenti a linea singola e multilinea.
- Applicare commenti per migliorare la leggibilità del codice.
- Conoscere le buone pratiche nella scrittura dei commenti.
Introduzione¶
Nel processo di scrittura del codice, i commenti sono fondamentali per rendere il programma più comprensibile non solo per gli altri sviluppatori, ma anche per te stesso quando ritorni sul codice dopo un certo tempo. In Python, i commenti permettono di inserire annotazioni che l’interprete ignorerà durante l’esecuzione, fornendo così spiegazioni o chiarimenti utili.
# Questo è un commento a linea singola
Esempio:
# Assegniamo il valore 10 alla variabile x
x = 10
Commenti Multilinea¶
Per commenti che si estendono su più linee, ci sono due approcci:
Utilizzo di
#all’inizio di ogni linea:# Questo è un commento # che si estende su più linee # utilizzando il simbolo # all'inizio
Utilizzo di stringhe multilinea non assegnate:
Python permette di creare stringhe multilinea utilizzando tripli apici, sia doppi
"""che singoli'''. Se queste stringhe non sono assegnate a una variabile o utilizzate come docstring, vengono ignorate dall’interprete.""" Questo è un commento multilinea utilizzando stringhe tra triple virgolette. """
Nota: Sebbene le stringhe multilinea non assegnate funzionino come commenti, è preferibile utilizzare # per coerenza e leggibilità.
# Calcolo dell'area di un rettangolo
base = 5
altezza = 10
area = base * altezza
print("L'area del rettangolo è:", area)
L'area del rettangolo è: 50
Spiegazione:
- Il commento spiega che il codice calcola l’area di un rettangolo.
- Aiuta a capire l’intento del codice senza dover analizzare le singole linee.
Esempio 2: Commenti Multilinea con #¶
# Questo programma verifica se un numero è pari o dispari
# Utilizza l'operatore modulo per determinare il resto
# Stampa il risultato all'utente
numero = 7
if numero % 2 == 0:
print("Il numero è pari")
else:
print("Il numero è dispari")
Il numero è dispari
Spiegazione:
- I commenti iniziali forniscono una panoramica del programma.
- Ogni lineetta commentata spiega una parte specifica.
Esempio 3: Stringhe Multilinea come Commenti¶
"""
Questo codice calcola la somma dei numeri da 1 a 10
e stampa il risultato.
"""
somma = 0
for i in range(1, 11):
somma += i
print("La somma è:", somma)
La somma è: 55
Spiegazione:
- La stringa multilinea non assegnata viene ignorata dall’interprete.
- Serve come commento iniziale per il codice.
Esempio 4: Commenti Inline¶
import math
raggio = 5 # Raggio del cerchio
area = math.pi * raggio ** 2 # Formula dell'area del cerchio
print("L'area del cerchio è:", area)
L'area del cerchio è: 78.53981633974483
Spiegazione:
- I commenti inline seguono il codice sulla stessa linea.
- Forniscono spiegazioni brevi e immediate.
velocita = 60
tempo = 2
distanza = velocita * tempo
print("La distanza percorsa è:", distanza)
La distanza percorsa è: 120
Soluzione:
# Velocità in km/h
velocita = 60
# Tempo in ore
tempo = 2
# Calcolo della distanza percorsa
distanza = velocita * tempo
print("La distanza percorsa è:", distanza)
La distanza percorsa è: 120
Esercizio 2: Utilizza Commenti per Disabilitare Codice¶
Il seguente codice genera un errore. Utilizza un commento per disabilitare la linea problematica.
numero = int(input("Inserisci un numero: "))
print("Hai inserito il numero:", numero)
print("Il numero diviso per zero è:", numero / 0)
Soluzione:
numero = int(input("Inserisci un numero: "))
print("Hai inserito il numero:", numero)
# Questa operazione genera un errore di divisione per zero
# print("Il numero diviso per zero è:", numero / 0)
Inserisci un numero: 3 Hai inserito il numero: 3
Esercizio 3: Scrivi un Commento Multilinea¶
Scrivi un commento multilinea che spieghi l’obiettivo del seguente codice.
for i in range(1, 6):
print(i * "*")
* ** *** **** ***** ****** ******* ******** ********* ********** *********** ************ ************* ************** *************** **************** ***************** ****************** *******************
Soluzione:
"""
Questo codice stampa una piramide di asterischi:
*
**
***
****
*****
# """
for i in range(1, 6):
print(i * "*")
* ** *** **** *****
Buone Pratiche e Consigli¶
- Sii Chiaro e Conciso: I commenti dovrebbero aiutare a capire il codice senza essere prolissi.
- Evita l’Ovvio: Non commentare ciò che è evidente. Es.
i += 1 # Incrementa i di 1è ridondante. - Aggiorna i Commenti: Mantieni i commenti sincronizzati con il codice. Commenti obsoleti possono creare confusione.
Usa Docstring per Funzioni e Classi: Forniscono una documentazione utile e possono essere accessibili tramite
help().Esempio:
def saluta(nome): """Questa funzione saluta la persona passata come parametro.""" print("Ciao,", nome)
Segui gli Standard di Codifica: Adotta le convenzioni come quelle descritte in PEP 8 per uniformità.
Conclusione¶
I commenti sono strumenti essenziali per rendere il codice Python più leggibile e mantenibile. Utilizzandoli correttamente, facilitano la comprensione del codice sia per te che per altri sviluppatori. Ricorda di essere coerente e di mantenere i commenti aggiornati in modo che riflettano sempre l’attuale stato del codice.
Risorse Aggiuntive¶
- Documentazione Ufficiale Python: Comments
- Libro Consigliato: Python Crash Course di Eric Matthes
- Video Tutorial: Comments