Doctring numpy
Dato che sappiamo già come scrivere i commenti multiline. Usiamo una stringa di documentazione quando vogliamo descrivere le nostre funzioni in modo da poter ottenere la documentazione quando ne abbiamo bisogno. Alcuni IDE ti danno la documentazione semplicemente passando al nome e alcuni evidenziano alcune parole chiave. Ma il fatto è che i dottori in numpy sono molto più flessibili che in altre lingue. Il dottore è una stringa letterale che si verifica all'inizio della definizione della funzione. Dobbiamo fornire valori specifici durante l'utilizzo dei documenti in caso di funzioni, classi, ecc.
Quando si utilizzano documenti con funzioni, dobbiamo passare gli argomenti. Quando li usi 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 l'elenco dei moduli con funzionalità. Quindi, fondamentalmente, lo scopo del dottore è, come spiega il nome, che aiuta con la documentazione del nostro codice. Facciamo documentazione in modo che se qualcuno usa 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 hanno anche documenti; Possiamo usare la funzione di aiuto () per esaminare il dottore delle funzioni integrate.
Ci sono alcune differenze tra commenti e documenti. I commenti sono ignorati dagli interpreti ma i documenti non sono ignorati dagli interpreti. La memoria è assegnata per i documenti. Un commento è una descrizione del codice ma d'altra parte, i documenti ci dicono lo scopo del codice.
Sintassi:
La sintassi per scrivere i documenti in numpy è:
"" "Messaggio di dottore" ""O
"Messaggio di dottore"
Si prega di notare che il docstring non è una funzione o un metodo, quindi non ha una sintassi adeguata. L'unica cosa da notare qui è che iniziamo il dottore con tre singole citazioni o tre doppie citazioni. Scriviamo la nostra descrizione del codice e lo terminiamo di nuovo con tre citazioni singole o tre doppie citazioni alla fine. Non c'è cosa obbligatoria da scrivere per i documenti. Devi solo mettere tre citazioni single o doppie prima e dopo la descrizione della stringa.
Esempio 1:
Per comprendere i documenti in modo migliore, eseguiamo un esempio. In questo esempio, dopo aver incluso la libreria numpy, dichiariamo semplicemente la variabile "A" e un'altra variabile "B". Successivamente, creiamo il nostro dottore che dice "Aggiungiamo variabili" A "e" B "". Nel nostro caso, questo è un esempio facile ma se il nostro codice è complesso, questo aiuta molto il programmatore a comprendere il codice. Successivamente, riassumiamo le variabili "A" e "B" e memorizziamo il loro output in un'altra variabile che è "C". Infine, stampiamo il valore della variabile "C". Ora eseguiamo il nostro codice.
Importa Numpy come NPa = 1
B = 2
"Aggiungiamo variabili A e B"
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 linea7 del nostro codice. Inoltre, il sistema non ha stampato il nostro dottore. Invece, ha stampato solo l'output della nostra variabile "C" in cui abbiamo detto al nostro sistema di stampare. Questo mostra come funzionano i dottori. La prossima volta, quando un nuovo programmatore cerca di lavorare sul nostro codice, capirà cosa stiamo facendo con l'aiuto del nostro dottore. Ma non verrà stampato come output in modo che l'utente del codice non ne sia disturbato.
Esempio 2:
Ora eseguiamo un esempio complesso per comprendere il lavoro del dottore. Innanzitutto, includiamo la libreria numpy e poi scriviamo una stringa Doc in cui spieghiamo la riga di codice successiva in cui spieghiamo l'inizializzazione dell'array. Aggiungiamo anche i documenti nell'altra parte del codice. Ora, se condividiamo questo codice con qualsiasi nuovo sviluppatore di Python senza aggiungere i documenti, sarà in qualche modo difficile per lui conoscere il lavoro e lo scopo di questo codice. Deve cercare prima le funzioni che abbiamo usato. Ma se aggiungiamo un dottore al nostro codice, sarà facile per gli altri sviluppatori comprendere il codice senza studiare di più sulle funzioni. Non siamo limitati all'aggiunta di commenti ad alcuni limiti; I commenti possono essere di una o più di una riga. 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"array = np.Array ([11, 22, 33, 44, 55, 66])
"Assegnare l'array alla funzione tofile () per lasciarlo salvare nel file denominato arr"
vettore.tofile ("arr.bidone")
"Visualizza il file utilizzando FromFile Function"
Stampa (NP.FromFile ("arr.bin ", dtype = int))
Come mostrato nel seguente frammento, i documenti non vengono visualizzati nell'output, il che significa che non influisce sull'output o la compilazione del codice. I documenti vengono ignorati durante il processo di compilazione.
Conclusione
In questa guida, abbiamo imparato a conoscere i dottori in numpy. Abbiamo confrontato i documenti con i commenti e abbiamo spiegato la differenza tra entrambi. Abbiamo imparato la sintassi dei documenti e come scrivere i documenti nel nostro codice. Inoltre, abbiamo anche cercato di spiegare quali sono i dottori di Numpy e come funzionano con l'aiuto di esempi. Infine, abbiamo osservato che sono essenziali per i programmatori. Non ripeteremo l'importanza dei documenti in Numpy. Diremo solo che dovresti usare i documenti nel tuo codice. In Numpy, lo stile di scrittura dei documenti è il più popolare. È ampiamente utilizzato nella comunità di programmazione per farsi conoscere l'un l'altro il lavoro e la funzionalità dei loro codici. Questa guida ti aiuterà a iniziare con i documenti numpy. Abbiamo cercato di coprire la maggior parte di ciò di cui avrai bisogno usando i documenti in numpy.