Commenti in Python sono le righe del codice che vengono ignorate dall'interprete durante l'esecuzione del programma.
# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''> |
>
>
I commenti migliorano la leggibilità del codice e aiutano i programmatori a comprenderlo con molta attenzione. Aiuta anche a collaborare con altri sviluppatori poiché l'aggiunta di commenti semplifica la spiegazione del codice.
Tipi di commenti in Python
Ci sono tre tipi di commenti in Python:
- Commenti a riga singola
- Commenti su più righe
- Stringhe letterali
- Commenti sulla stringa di documenti
Commenti in Python
Nell'esempio si può vedere questo Pitone I commenti vengono ignorati dall'interprete durante l'esecuzione del programma.
Python3
# sample comment> name>=> 'geeksforgeeks'> print>(name)> |
>
>
Produzione:
geeksforgeeks>
Perché vengono utilizzati i commenti in Python?
I commenti sono stati parte integrante dei linguaggi di programmazione e ogni linguaggio ha modi diversi di utilizzare i commenti.
Proprio come qualsiasi altro linguaggio, i commenti in Python hanno il seguente scopo:
- Migliora la leggibilità del codice
- Spiegare il codice agli altri
- Comprendere il codice se studiato dopo un po' di tempo
- Documentare i passaggi e le esigenze di una funzione
- Condivisione del codice con altri sviluppatori
- Collaborare con più persone.
Tipi di commenti in Python
Scopriamo le diverse tipologie di commenti, come utilizzarli e quando utilizzarli?
1. Linea singola Commenti
- Il commento Python a riga singola inizia con il simbolo dell'hashtag (#) senza spazi bianchi e dura fino alla fine della riga.
- Se il commento supera una riga, inserisci un hashtag nella riga successiva e continua il commento Python.
- I commenti a riga singola di Python si sono rivelati utili per fornire brevi spiegazioni per variabili, dichiarazioni di funzioni ed espressioni. Vedi il seguente frammento di codice che mostra il commento a riga singola:
Esempio:
Python3
creazione di tabelle in lattice
# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)> |
>
>Produzione
techcodeview.com>
2. Commenti su più righe
Python non fornisce l'opzione per commenti su più righe . Tuttavia, esistono diversi modi attraverso i quali possiamo scrivere commenti su più righe.
a) Commenti su più righe utilizzando più hashtag (#)
Possiamo più hashtag (#) per scrivere commenti su più righe in Python. Ogni riga verrà considerata come un commento a riga singola.
Python3
# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)> |
>
>Produzione
Multiline comments>
Controlla anche: Fatto interessante sui commenti su più righe di Python
allinea l'immagine con i css
3. Stringhe letterali
Python ignora il stringhe letterali che non sono assegnati a una variabile, quindi possiamo usare queste stringhe letterali come commenti Python .
a) Commenti a riga singola utilizzando stringhe letterali
Eseguendo il codice sopra possiamo vedere che non ci sarà alcun output quindi utilizziamo le stringhe con virgolette triple () come commenti su più righe.
Python3
'This will be ignored by Python'> |
>
>
riduzione di Python
b) Commenti su più righe utilizzando stringhe letterali
Python3
''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)> |
>
>Produzione
Multiline comments>
4. Stringa di documento
- Stringa di documento Python sono le stringhe letterali con virgolette triple che appaiono subito dopo la funzione.
- Viene utilizzato per associare la documentazione scritta con moduli, funzioni, classi e metodi Python.
- Viene aggiunto proprio sotto le funzioni, i moduli o le classi per descrivere cosa fanno. In Python, la docstring viene quindi resa disponibile tramite l'attributo __doc__.
Esempio:
Python3
def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)> |
>
>
Produzione:
Multiplies the value of a and b>
Vantaggi dei commenti in Python
I commenti vengono generalmente utilizzati per i seguenti scopi:
- Leggibilità del codice
- Spiegazione del codice o dei metadati del progetto
- Impedire l'esecuzione del codice
- Per includere risorse
Il modo giusto per scrivere commenti
I commenti hanno lo scopo principale di spiegare il codice. Gli sviluppatori utilizzano una sana pratica di scrittura dei commenti per una migliore comprensione del codice.
Alcuni dei suggerimenti che puoi seguire per rendere efficaci i tuoi commenti sono:
- I commenti dovrebbero essere brevi e precisi.
- Utilizza i commenti solo quando necessario, non ingombrare il codice con commenti.
- Il commento dovrebbe avere un significato.
- Evita di scrivere commenti generici o basilari.
- Scrivi commenti che siano autoesplicativi.
Abbiamo discusso tutto sui commenti Python, come scrivere commenti Python, tipi di commenti, quali sono i vantaggi e il modo giusto di scrivere commenti.
Leggi anche: Come scrivere commenti in Python3?