Esempio di dottore di Python
Mentre i commenti sono utilizzati per programmi, dichiarazioni ed espressioni, che in genere sono brevi, i documenti sono eccellenti per comprendere il funzionamento della parte più ampia dello script come l'uso generale di qualsiasi modulo, classe o funzione. Sono una descrizione di una riga di codice o istruzione prodotta da un programmatore che di solito è per se stesso capire cosa fa. È fondamentale documentare il tuo codice correttamente se si desidera scrivere programmi con codice chiaro e buona documentazione. I documenti vengono forniti, utilizzando le "triple citazioni singole" o "triple doppie citazioni" subito dopo la funzione di funzione, classe o metodo.
Esempio 1: Programma di Python Doctring Triple Quotes
O il metodo __doc__ dell'oggetto o la funzione di aiuto possono essere utilizzati per ottenere i documenti. La dichiarazione e l'uso di un docstring con le triple citazioni singole sono mostrate nei seguenti esempi:
Inizia con la definizione di una funzione in Python. Creiamo una funzione come my_func (). All'interno del corpo del MY_FUNC, abbiamo come dottore avvolto attorno alle triple citazioni singole. Quindi, alla fine della funzione, eseguiamo esplicitamente l'istruzione di ritorno che restituisce il valore nessuno. La funzione di stampa prende my_func con l'oggetto _doc_ che visualizzerà il dottore. Inoltre, abbiamo una funzione di aiuto Python che viene utilizzata per stampare la documentazione della funzione MY_FUNC.
Quando questo particolare programma viene debug ed eseguito, genera i seguenti risultati nella schermata della console di Spyder:
Esempio 2: Programma di Python Doctring Triple Double Quotes
Il codice seguente distribuisce la dichiarazione di dottore e utilizza con le doppie ciuzioni triple:
Qui, diamo un nome di funzione my_func2. All'interno del corpo del MY_FUNC2, dichiariamo un dottore con la tripla doppia citazione. Quindi, chiamiamo l'oggetto _doc_ di Python per stampare il dottore specificato e la documentazione della funzione my_func2 con la funzione di aiuto.
I risultati generati dai codici sopra menzionati sono i seguenti. Questo output è generato dall'esecuzione del codice apposto precedente in Spyder:
Esempio 3: Programma di Python One-line Doctring
I documenti di una linea sono proprio ciò che suggerisce il loro nome: una riga. Sono impiegati in situazioni palesi. Le ultime citazioni sono situate su una linea simile a quelle iniziali. Per una linea sola, questo sembra più attraente.
Qui, costruiamo una funzione come "Aggiungi" che richiede due argomenti: X e Y. Quindi, dichiariamo il documento di una linea all'interno del corpo della definizione della funzione "Aggiungi". L'istruzione di ritorno restituisce il valore dall'aggiunta dei due valori. L'istruzione di stampa è invocata per la visualizzazione del dottore all'interno della funzione Aggiungi utilizzando l'oggetto _doc_.
I risultati del docstring a una linea sono mostrati nella seguente schermata della console Spyder. Questo output è generato dall'esecuzione del codice apposto sopra in Spyder:
Esempio 4: Programma di un dottore python Multi-Line
Simile ai documenti a una riga, i documenti multi-line iniziano con una riga di riepilogo e termina con una linea vuota prima di descrivere qualcosa in modo più dettagliato. La riga di riepilogo può apparire su una riga simile alle citazioni iniziali o su una linea diversa. Nel seguente istanza viene dimostrato un dottore multilineo:
In questo particolare esempio di esempio, abbiamo la definizione della funzione che viene fornita un nome come python_function. Questa funzione prende un valore dell'argomento x. Il corpo della funzione viene dichiarato con la stringa multilinea che è la descrizione del valore dell'argomento e del tipo di dati INT. Successivamente, il comando di ritorno è definito. Il dottore multilinea viene visualizzato chiamando l'oggetto _doc_ all'interno della funzione di stampa.
Le più linee del dottore sono stampate sul terminale Spyder come segue:
Esempio 5: Programma di Python Doctring rientramento
Le citazioni sulla sua linea iniziale sono rientrate alla stessa quantità del resto del dottore. Ogni rientro nella prima riga del dottore (fino alla prima linea di nuova linea) non è necessaria e dovrebbe essere eliminata. Successivamente, le linee nel dottore mantengono la loro relativa rientranza. Come illustrazione su come creare i documenti per una classe e i suoi metodi, diamo un'occhiata a un esempio. L'accesso al dottore è tramite aiuto:
Definiamo una classe con la classe di parole chiave e nominiamo quella classe come my_python_example. All'interno della classe my_python_example, dichiariamo il dottore che è circondato dalla tripla doppia citazione. Quindi, creiamo il quadrato di funzione che ha l'ingresso x e la funzione è anche dichiarata con il dottore. Quindi, creiamo un'altra funzione con il nome, cubo. Ci vuole anche un input n. Questa funzione è creata per il cubo del numero. Questa affermazione è spiegata dalla Dichiarazione di Doctring. Successivamente, abbiamo una funzione di aiuto Python per eseguire la documentazione della classe My_Python_Program e della funzione Square.
Dal programma Python precedentemente menzionato, si ottiene il seguente output elencato. Questo output è generato dall'esecuzione del codice precedentemente apposto in Spyder:
Conclusione
L'obiettivo principale di questo corso è quello di familiarizzare con i documenti esaminando le idee fondamentali. Tuttavia, poiché i documenti sono un argomento così ampio, è possibile che alcune idee siano state saltate. Per ottenere la documentazione di una funzione, utilizzare la funzione Help (). Metti una stringa, una stringa singola o una stringa multilinea, nella prima riga della funzione per aggiungere la documentazione.