In questo articolo approfondiremo il concetto di commenti su più righe in Python, fornendo una definizione completa insieme ad esempi illustrativi nel linguaggio di programmazione Python su Come commentare più righe in Pitone .
Cos'è un commento su più righe in Python?
I commenti su più righe in Python si riferiscono a un blocco di testo o istruzioni utilizzate per scopi esplicativi o di documentazione all'interno del codice. A differenza dei commenti su riga singola contrassegnati dal simbolo cancelletto (#), i commenti su più righe sono racchiusi tra virgolette triple doppie (``) o virgolette singole triple (`’`). Questi commenti vengono spesso utilizzati per fornire spiegazioni dettagliate, documentazione o note sul codice e possono estendersi su più righe. Sebbene Python non abbia una sintassi specifica per i commenti su più righe, l’uso delle virgolette triple ottiene un effetto simile, poiché l’interprete ignora il testo racchiuso.
Tipi di commenti su più righe in Python
Esistono due modi con cui possiamo aggiungere commenti multilinea Python nel nostro codice. Sono i seguenti:
- Commento consecutivo di una sola riga
- Utilizzo di una stringa su più righe come commento
- Utilizzando il metodo della barra rovesciata
Commenta più righe in Python utilizzando commenti consecutivi a riga singola
In Pitone , il carattere cancelletto(#) viene utilizzato per commentare la riga. Linea singola commenti in Python non devono essere solo testo per spiegare il codice, possono anche essere usati per impedire a Python di eseguire il codice. Il carattere hash dovrebbe essere posizionato prima di ogni riga per essere considerato come commento su più righe in Python.
Esempio: commento consecutivo su riga singola
Qui, le prime due righe contengono un carattere hash (#) e l'interprete impedisce l'esecuzione delle due righe. Quindi stampa i commenti Python e infine impedisce l'esecuzione dell'ultima riga.
Python3
# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')> Produzione:
Python Comments>
Commenta più righe in Python utilizzando una stringa multilinea come commento
I commenti multilinea Python possono anche essere racchiusi in un delimitatore (). Anche in questo caso non dovrebbero esserci spazi bianchi tra i delimitatori (). Sono utili quando il testo del commento non rientra in una riga, quindi deve estendersi su più righe. Questo tipo di stringa letterale viene ignorata poiché non è assegnata ad alcuna variabile. Possiamo accedere a queste stringhe usando __doc__.
Esempio: utilizzo di una stringa multilinea come commento
I commenti su più righe vengono utilizzati per commentare più di una riga. La prima riga è un commento di una sola riga. La seconda e la terza riga possono essere commentate utilizzando le virgolette triple( ). Ciò impedisce l'esecuzione del codice precedente. Infine, stampa Matematica nell'output. Tuttavia, se questi commenti multilinea Python vengono posizionati direttamente dopo una funzione o una firma di classe, diventano docstring .
Python3
# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')> Produzione:
Mathematics>
Commenta più righe in Python utilizzando il metodo barra rovesciata
Un metodo per creare commenti su più righe in Python prevede l'utilizzo della barra rovesciata (``) alla fine di ogni riga per utilizzare la funzionalità di continuazione della riga, consentendo così al commento di estendersi alla riga successiva. Questo metodo di continuazione della riga è meno comune rispetto ad altri approcci come commenti consecutivi su riga singola o stringhe su più righe e viene utilizzato principalmente per scopi di leggibilità del codice quando è necessario suddividere un commento su più righe.
Esempio : In questo esempio, i commenti che iniziano con#>vengono estesi su più righe utilizzando la barra rovesciata (>) alla fine di ogni riga. La barra rovesciata indica che il commento continua nella riga successiva. Questo metodo può essere utile per migliorare la leggibilità del codice quando sono presenti commenti lunghi.
# Using backslash for multiline comments # This is a long comment # that spans multiple lines # using the backslash continuation method. # Code continues below print('Hello, World!')> Produzione :
Hello, World!>
Docstring in Python
IL docstring è una funzionalità integrata di Python, che viene utilizzata 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 il file Python __doc__ attributo.
Esempio: Docstring in Python
In questo esempio, dopo aver definito la funzione multiply(), abbiamo dichiarato un commento docstring utilizzando le virgolette triple. Quindi stampiamo la docstring utilizzando l'attributo __doc__.
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:
Java se altro
Multiplies the value of a and b>
Differenza tra commenti e Docstring in Python
Vediamo la differenza tra commenti Python e Docstring:
Commenti | Docstring |
|---|---|
| Sono dichiarati utilizzando # | Sono dichiarati utilizzando |
| Utilizzato per aumentare la leggibilità del codice | Fornisce una descrizione dei moduli, delle funzioni e delle classi Python |
| Non è possibile accedervi | È possibile accedervi utilizzando __doc__ |