Python docstring

Dokumentationen är nödvändig för att alla programmeringar ska förstå koden enkelt. Den används för att förklara syftet med att använda något uttalande eller funktion eller klass eller modul i programmet. Det hjälper huvudkodaren att komma ihåg vilken kod som helst efter lång tid, och det hjälper också andra kodare som vill arbeta med samma projekt. Kodaren använder en enda rad kommentarer för att förklara den specifika delen av kodens funktion inom kort. Python-dokumentsträng eller docstring används för att förklara funktionen hos ett visst segment av koden i detalj. Doktringslinjen bör börja med versalen och sluta med en punkt. Den första raden i dokstringen innehåller en kort beskrivning av dokumentationen i allmänhet. Den andra raden i docstringen ska vara tom för den stora multi-line-docstringen. Trippel enkla citat ('”) eller trippel dubbla citat (“” ”) används för att definiera docstring i Python. Docstring-innehållet kan nås med hjälp av den __doc__ objektets attribut och använda hjälp() metod. Sättet att förklara och komma åt docstring i Python har visat i denna handledning.

Exempel 1: Åtkomst till doktring av en funktion med __doc__ attribut

Sättet att deklarera och komma åt doktringen för en anpassad funktion har visats i följande skript. Följande skript beräknar xⁿ där x och n kommer att tas från användaren. Kraft () funktionen har definierats i skriptet för att utföra uppgiften. Här har doktringen definierats för denna funktion. __doc__ attribut har använts i manuset för att skriva ut docstring med utdata.

def-effekt (x, n):
"Beräkna x till effekten n
Läs värdena för x och n från funktionsargumenten
och Beräkna och returnera värdet av x till effekten n."
returnera x ** n
# Ta värdet på x
x = int (input ('Enter the value of x:'))
# Ta värdet av n
n = int (input ('Ange värdet på n:'))
# Skriv ut returvärdet för funktionsfunktionen
skriva ut ("% d till effekt% d =% d"% (x, n, effekt (x, n)))
# Skriv ut dokstringsvärdet
print ("Innehållet i docstring: \ n" + power.__doc__)

Produktion:

Följande utdata visas efter att ovanstående skript har körts.

Exempel 2: Åtkomst till dokstring av klass och metod med hjälp av hjälp() metod

Sättet att förklara och få tillgång till dokumentets doktring och metoderna för den klassen har visats i följande skript. Skriptets huvudsakliga funktion är att sortera en numerisk lista och vända listans data. En numerisk lista med åtta element har deklarerats i klassen och doktringen har definierats i början av klassen med hjälp av trippel enkla citat. Metoden sort_list () har definierats i klassen för att skriva ut de sorterade data i listan, och dokumentet har definierat detta för denna metod. reverse_list () metod definieras för att skriva ut listans omvända data, och docstring har också definierats för denna metod. hjälp() metoden har kallat tre gånger i slutet av skriptet för att skriva ut docstring av lista_operationer klass, sort_list () metod och reverse_list () metod.

klasslista_operationer:

klasslista_operationer:
"
Sortera och vända listdata
Kursen innehåller två metoder,
sort_list () -metoden sorterar och skriver ut listan,
sort_reverse () -metoden kommer att vända och skriva ut listan.
"
# Definiera en lista med numeriska data
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (själv):
"
Skriv ut listvärdena efter sortering
Funktionen tar ett listobjekt med numeriska data från argumentet,
sortera listvärdena med metoden sort ()
och skriv ut värdena i den sorterade listan.
"
# Sortera listan
själv.listdata.sortera()
# Skriv ut den sorterade listan med loop
print ("Värdena i den sorterade listan: \ n")
för värde i sig själv.listdata:
skriv ut (värde, "", slut = ")
def reverse_list (själv):
"
Skriv ut listvärdena efter att ha vänt
Funktionen tar ett listobjekt med numeriska data från argumentet,
vänd listvärdena med metoden reverse ()
och skriv ut värdena för den omvända listan.
"
# Omvänd listan
själv.listdata.omvänd()
# Skriv ut den omvända listan med hjälp av loop
print ("Värdena i den sorterade listan: \ n")
för värde i sig själv.listdata:
skriva ut (värde, "", slut = ")
# Skriv ut docstring-värdet för klassen
hjälp (list_operationer)
# Skapa objekt av klassen
obj = lista_operationer ()
# Skriv ut docstringvärdet för den specifika metoden
hjälp (obj.sort_lista)
# Ring metoden för att skriva ut den sorterade listan
obj.sort_list ()

Produktion:

Följande utdata visas efter att manuset har körts. All dokumentation av manuset har skrivits ut för första gången hjälp() fungera. Doktringen av sort_list () metoden har skrivits ut för den andra hjälp() fungera.

Exempel 3: Åtkomst till dokstring av den inbyggda Python-modulen

I de föregående exemplen har docstring använts i användardefinierad klass och funktion. Varje inbyggd Python-modul och klass har sin docstring som förklarar syftet med att använda den specifika modulen eller funktionen. Kodaren för modulen eller funktionen definierar docstring för att göra koden förståelig för användarna. Följande skript skriver ut den fördefinierade dokstringen för datetime-modulen med hjälp av hjälp() fungera.

# Importera datetime-modul
importera datatid
# Visa doktringen för datetime
hjälp (datetime)

Produktion:

Följande utdata visas efter att manuset har körts. Doktringen av datetime-modulen visar den detaljerade dokumentationen av den för att hjälpa de andra att känna till funktionerna för de klasser och metoder som definieras i denna modul korrekt.

Slutsats:

Korrekt dokumentation är viktigt när någon modul eller funktion implementeras för det specifika syftet för att hjälpa den andra kodaren att använda modulen i sin kod för att utföra den specifika uppgiften. Om dokumentationen inte är korrekt definierad för modulen eller funktionen kommer de andra användarna att få problem med att använda den. Så varje kodare måste använda dokumentets dokument för att ge detaljerad information för de andra för att förstå koden.