In questo tutorial impareremo a creare commenti in Python con l'aiuto di esempi.
Video: commenti in Python
I commenti sono descrizioni che aiutano i programmatori a comprendere meglio l'intento e la funzionalità del programma.
Sono completamente ignorati dall'interprete Python.
Vantaggi dell'utilizzo dei commenti
L'uso dei commenti nei programmi rende il nostro codice più comprensibile. Rende il programma più leggibile, il che ci aiuta a ricordare perché sono stati scritti determinati blocchi di codice.
Oltre a ciò, i commenti possono essere utilizzati anche per ignorare parte del codice durante il test di altri blocchi di codice. Questo offre un modo semplice per impedire l'esecuzione di alcune righe o scrivere uno pseudo codice veloce per il programma.
Commenti su una sola riga in Python
In Python, usiamo il simbolo hash #per scrivere un commento su una sola riga.
Esempio 1: scrittura di commenti su una riga
# printing a string print('Hello world')
Produzione
Ciao mondo
Qui il commento è:
# printing a string
Questa riga viene ignorata dall'interprete Python.
Tutto ciò che viene dopo #viene ignorato. Quindi, possiamo anche scrivere il programma sopra in una singola riga come:
print('Hello world') #printing a string
L'output di questo programma sarà lo stesso dell'esempio 1 . L'interprete ignora tutto il testo dopo #.
Commenti su più righe in Python
Python non offre un modo separato per scrivere commenti su più righe. Tuttavia, ci sono altri modi per aggirare questo problema.
Possiamo usare #all'inizio di ogni riga di commento su più righe.
Esempio 2: utilizzo di più #
# it is a # multiline # comment
Ogni riga viene trattata come un singolo commento e tutti vengono ignorati.
Valori letterali stringa per commenti su più righe
Anche se non esiste un modo univoco per scrivere commenti su più righe in Python, sappiamo che l'interprete Python ignora le stringhe letterali che non sono assegnate a una variabile.
Quindi, possiamo anche scrivere un commento di una riga come:
#this is a comment 'this is an unassigned string as a comment '
Qui, possiamo vedere che la seconda riga del programma è una stringa ma non è assegnata a nessuna variabile o funzione. Quindi, l'interprete ignora la stringa.
In modo simile, possiamo usare stringhe su più righe (virgolette triple) per scrivere commenti su più righe.
Il carattere di citazione può essere 'o ".
Esempio 3: utilizzo di stringhe letterali per scrivere commenti su più righe
''' I am a multiline comment! ''' print("Hello World")
Qui, la stringa multilinea non è assegnata a nessuna variabile, quindi viene ignorata dall'interprete. Anche se tecnicamente non è un commento su più righe, può essere utilizzato come tale.
Docstrings Python
Per convenzione, le virgolette triple che appaiono subito dopo la definizione di funzione, metodo o classe sono docstrings (stringhe di documentazione).
Le stringhe di documento sono associate agli oggetti e sono accessibili tramite l' __doc__attributo.
Per saperne di più, visita docstrings Python.
Come scrivere commenti migliori?
- Usa i commenti per descrivere cosa fa una funzione e non i dettagli specifici su come la fa.
- Prova a rimuovere il maggior numero possibile di commenti ridondanti. Prova a scrivere codice che possa spiegare se stesso, utilizzando una migliore scelta del nome di funzione / variabile.
- Cerca di rendere i commenti il più brevi e concisi possibile.
