Python Doctring

La documentazione è essenziale per qualsiasi programmazione per comprendere facilmente il codice. Viene utilizzato per spiegare lo scopo di utilizzare qualsiasi istruzione o funzione o classe o modulo nel programma. Aiuta il codificatore principale a ricordare la funzione di qualsiasi codice dopo molto tempo e aiuta anche altri programmatori che vogliono lavorare sullo stesso progetto. Il programmatore utilizza una singola riga di commento per spiegare a breve la parte particolare della funzione del codice. Python Document String o Doctring viene utilizzato per spiegare in dettaglio la funzione di un particolare segmento del codice. La linea di dottore dovrebbe iniziare con la lettera maiuscola e terminare con un periodo. La prima riga del dottore contiene una breve descrizione della documentazione in generale. La seconda riga del dottore dovrebbe essere vuota per il grande dottore multilinea. Triple citazioni single ('") O triple doppie citazioni ("" ") sono usati per definire il dottore in Python. È possibile accedere al contenuto di dottore utilizzando utilizzando il __doc__ attributo dell'oggetto e usando il aiuto() metodo. Il modo di dichiarare e accedere a Doctring in Python ha mostrato in questo tutorial.

Esempio-1: accedere al dottore di una funzione usando __doc__ attributo

Il modo di dichiarare e accedere al dottorato di una funzione personalizzata ha mostrato nel seguente script. Il seguente script calcola la x^N dove X e N verranno prelevati dall'utente. Energia () La funzione ha definito nello script per eseguire l'attività. Qui, il dottore è stato definito per questa funzione. __doc__ L'attributo è stato utilizzato nello script per stampare il dottore con l'output.

Def Power (x, n):
"Calcola x alla potenza n
Leggi i valori di X e N dagli argomenti della funzione
e calcolare e restituire il valore di x alla potenza n."
restituire x ** n
# Prendi il valore di x
x = int (input ('immettere il valore di x:'))
# Prendi il valore di n
n = int (input ('immettere il valore di n:'))
# Stampa il valore di ritorno della funnction
Stampa ("Il %d alla potenza %d = %d" %(x, n, potenza (x, n)))
# Stampa il valore di dottore
Stampa ("Il contenuto del dottore: \ n" + potenza.__doc__)

Produzione:

Verrà visualizzato il seguente output dopo aver eseguito lo script sopra.

Esempio-2: accedere al dottore della classe e del metodo utilizzando aiuto() metodo

Il modo di dichiarare e accedere al documento del documento e i metodi di quella classe hanno mostrato nel seguente script. La funzione principale dello script è di ordinare un elenco numerico e invertire i dati dell'elenco. Un elenco numerico di 8 elementi è stato dichiarato in classe e il dottore è stato definito all'inizio della classe utilizzando triple citazioni singole. Il metodo Sort_list () è stato definito nella classe per stampare i dati ordinati dell'elenco e il documento lo ha definito Per questo metodo. reverse_list () Il metodo è definito per stampare i dati invertiti dell'elenco e il dottore è stato definito anche per questo metodo. aiuto() Il metodo ha chiamato tre volte alla fine dello script per stampare il dottore del list_operations classe, sort_list () metodo e il reverse_list () metodo.

Class List_operations:

Class List_operations:
"
Ordinamento e inversione dei dati dell'elenco
La classe contiene due metodi,
Il metodo Sort_List () ordinerà e stamperà l'elenco,
il metodo di sort_reverse () inverterà e stamperà l'elenco.
"
# Definisci un elenco di dati numerici
ListData = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
"
Stampa i valori dell'elenco dopo l'ordinamento
La funzione prenderà un oggetto elenco di dati numerici dall'argomento,
Ordina i valori dell'elenco utilizzando il metodo Ord ()
e stampare i valori dell'elenco ordinato.
"
# Ordina l'elenco
se stesso.ListData.ordinare()
# Stampa l'elenco ordinato usando loop
print ("I valori dell'elenco ordinato: \ n")
per valore in sé.ListData:
Stampa (valore ",", end = ")
def revers_list (self):
"
Stampa i valori dell'elenco dopo l'inversione
La funzione prenderà un oggetto elenco di dati numerici dall'argomento,
invertire i valori dell'elenco usando il metodo di reverse ()
e stampare i valori dell'elenco invertito.
"
# Invertire l'elenco
se stesso.ListData.inversione()
# Stampa l'elenco invertito usando loop
print ("I valori dell'elenco ordinato: \ n")
per valore in sé.ListData:
Stampa (valore ",", end = ")
# Stampa il valore di dottore della classe
Guida (list_operations)
# Crea oggetto della classe
obj = list_operations ()
# Stampare il valore di dottore del metodo particolare
Aiuto (OBJ.sort_list)
# Chiama il metodo per stampare l'elenco ordinato
obj.sort_list ()

Produzione:

Verrà visualizzato il seguente output dopo aver eseguito lo script. Tutto il dottore dello script è stato stampato per il primo aiuto() funzione. Il dottore del sort_list () Il metodo è stato stampato per il secondo aiuto() funzione.

Esempio-3: accedere al dottore del modulo Python integrato

Negli esempi precedenti, il docstring ha utilizzato nella classe e nella funzione definiti dall'utente. Ogni modulo e classe Python incorporato hanno il suo dottore che spiega lo scopo di usare quel particolare modulo o funzione. Il programmatore del modulo o della funzione definisce il dottore per rendere il codice comprensibile per gli utenti. Il seguente script stamperà il dottore predefinito del modulo DateTime utilizzando il aiuto() funzione.

# Importa modulo DateTime
Importa DateTime
# Visualizza il dottore di DateTime
Guida (DateTime)

Produzione:

Verrà visualizzato il seguente output dopo aver eseguito lo script. Il dottore del modulo DateTime mostra la sua documentazione dettagliata per aiutare gli altri a conoscere le funzioni delle classi e dei metodi definiti in questo modulo correttamente.

Conclusione:

La documentazione corretta è essenziale quando viene implementato qualsiasi modulo o funzione per lo scopo specifico per aiutare l'altro programmatore a utilizzare il modulo nel loro codice per eseguire l'attività particolare. Se la documentazione non è correttamente definita per il modulo o la funzione, gli altri utenti dovranno affrontare problemi utilizzandola. Pertanto, ogni programmatore deve utilizzare il dottore del documento per fornire informazioni dettagliate agli altri per comprendere il codice.