Poiché sappiamo già come scrivere i commenti su più righe, possiamo utilizzare le virgolette singole triple o le virgolette triple doppie. Usiamo una stringa di documentazione quando vogliamo descrivere le nostre funzioni in modo da poter ottenere la documentazione quando ne abbiamo bisogno. Alcuni IDE forniscono documentazione semplicemente passando il mouse sopra il nome e alcuni evidenziano determinate parole chiave. Ma il fatto è che le docstring in NumPy sono molto più flessibili rispetto ad altre lingue. Docstring è una stringa letterale che si verifica all'inizio della definizione della funzione. Dobbiamo fornire valori specifici durante l'utilizzo delle docstring in casi di funzioni, classi, ecc.
Quando si usano docstring con funzioni, dobbiamo passare gli argomenti. Quando li utilizziamo con le classi, passiamo gli attributi e i metodi. Nel caso dei moduli, dobbiamo fornire un elenco di classi e funzioni. Nel caso del pacchetto, passiamo all'elenco dei moduli con funzionalità. Quindi, in pratica, lo scopo della docstring è, come spiega il nome, che aiuta con la documentazione del nostro codice. Facciamo documentazione in modo che se qualcuno utilizzerà il nostro codice in futuro, sarà in grado di comprendere il nostro codice e la logica dietro il nostro codice con l'aiuto di docstring. Le funzioni integrate contengono anche docstring; possiamo usare la funzione di help() per guardare la docstring delle funzioni integrate.
Ci sono alcune differenze tra commenti e docstring. I commenti vengono ignorati dagli interpreti ma le docstring non vengono ignorate dagli interpreti. La memoria è allocata per le docstring. Un commento è una descrizione del codice ma d'altra parte, docstrings ci dice lo scopo del codice.
Sintassi:
La sintassi per scrivere le docstring in NumPy è:
'''Messaggio docstring'''
O
'''Messaggio docstring'''
Si noti che docstring non è una funzione o un metodo, quindi non ha una sintassi corretta. L'unica cosa da notare qui è che iniziamo la docstring con tre virgolette singole o tre virgolette doppie. Scriviamo la nostra descrizione del codice e la terminiamo di nuovo con tre virgolette singole o tre virgolette alla fine. Non c'è nulla di obbligatorio da scrivere per docstrings. Devi solo inserire tre virgolette singole o doppie prima e dopo la descrizione della stringa.
Esempio 1:
Per comprendere meglio le docstring, eseguiamo un esempio. In questo esempio, dopo aver incluso la libreria NumPy, dichiariamo semplicemente la variabile 'a' e un'altra variabile 'b'. Successivamente, creiamo la nostra docstring che dice 'Aggiungiamo le variabili 'a' e 'b''. Nel nostro caso, questo è un semplice esempio, ma se il nostro codice è complesso, questo aiuta molto il programmatore a capire il codice. Successivamente, riassumiamo le variabili 'a' e 'b' e memorizziamo il loro risultato di output in un'altra variabile che è 'c'. Infine, stampiamo il valore della variabile “c”. Ora eseguiamo il nostro codice.
importare intontito come per esempio.un = 1
b = Due
'''Aggiungiamo variabili aeb'''
c = a+b
Stampa ( c )
Questo è il nostro output dal dato pezzo di codice. Possiamo vedere che il sistema non ha dato alcun errore sulla sintassi errata o altro per la riga 7 del nostro codice. Inoltre, il sistema non ha stampato la nostra docstring. Invece, ha stampato solo l'output della nostra variabile 'c' in cui abbiamo detto al nostro sistema di stampare. Questo mostra come funzionano le docstring. La prossima volta, quando un nuovo programmatore proverà a lavorare sul nostro codice, capirà cosa stiamo facendo con l'aiuto della nostra docstring. Ma non verrà stampato come output, quindi l'utente del codice non ne sarà disturbato.
Esempio 2:
Ora, eseguiamo un esempio complesso per comprendere il funzionamento di docstring. Innanzitutto, includiamo la libreria NumPy e quindi scriviamo una stringa doc in cui spieghiamo la riga di codice successiva in cui spieghiamo l'inizializzazione dell'array. Aggiungiamo anche le docstring nell'altra parte del codice. Ora, se condividiamo questo codice con qualsiasi nuovo sviluppatore Python senza aggiungere le docstring, sarà in qualche modo difficile per lui conoscere il funzionamento e lo scopo di questo codice. Deve prima cercare le funzioni che abbiamo usato. Ma se aggiungiamo una docstring al nostro codice, sarà facile per gli altri sviluppatori capire il codice senza studiare di più le funzioni. Non siamo limitati ad aggiungere commenti ad alcuni limiti; i commenti possono essere di una o più righe. Può anche essere aggiunto più di una volta in un codice. Quindi, importa NumPy come np.
'''Creazione della variabile a cui passeremo un array di dimensioni 1x6'''Vettore = per esempio. Vettore ( [ undici , 22 , 33 , 44 , 55 , 66 ] )
'''assegnazione dell'array alla funzione tofile() per salvarlo nel file denominato arr'''
Vettore . tofile ( 'arr.bin' )
'''visualizza il file usando la funzione fromfile'''
Stampa ( per esempio. dal file ( 'arr.bin' , tipo d = int ) )
Come mostrato nel frammento di codice seguente, le docstring non vengono visualizzate nell'output, il che significa che non influisce sull'output o sulla compilazione del codice. Le docstring vengono ignorate durante il processo di compilazione.
Conclusione
In questa guida, abbiamo imparato a conoscere le docstring in NumPy. Abbiamo confrontato le docstring con i commenti e spiegato la differenza tra entrambi. Abbiamo imparato la sintassi delle docstring e come scrivere le docstring nel nostro codice. Inoltre, abbiamo anche cercato di spiegare cosa sono le docstring in NumPy e come funzionano con l'aiuto di esempi. Infine, abbiamo osservato che sono essenziali per i programmatori. Non ripeteremo l'importanza delle docstring in NumPy. Diremo solo che dovresti usare le docstrings nel tuo codice. In NumPy, lo stile di scrittura di docstrings è il più popolare. È ampiamente utilizzato nella comunità di programmazione per informarsi reciprocamente sul funzionamento e sulla funzionalità dei propri codici. Questa guida ti aiuterà a iniziare con NumPy docstrings. Abbiamo cercato di coprire la maggior parte di ciò di cui avrai bisogno usando le docstrings in NumPy.