Python dokstring

Dokumentasjonen er viktig for enhver programmering for å forstå koden enkelt. Den brukes til å forklare formålet med å bruke en hvilken som helst uttalelse eller funksjon eller klasse eller modul i programmet. Det hjelper hovedkoderen å huske funksjonen til hvilken som helst kode etter lang tid, og det hjelper også andre kodere som vil jobbe med det samme prosjektet. Koderen bruker en enkelt linje med kommentarer for å forklare den spesielle delen av kodens funksjon kort tid. Python-dokumentstreng eller docstring brukes til å forklare funksjonen til et bestemt segment av koden i detalj. Dokstringlinjen skal begynne med store bokstaver og slutte med en periode. Første linje i dokstringen inneholder en kort beskrivelse av dokumentasjonen generelt. Den andre linjen i dokstringen skal være blank for den store doktringen med flere linjer. Trippel enkelt anførselstegn ('”) eller trippel dobbelt anførselstegn (“” ”) brukes til å definere doktringen i Python. Dokstring-innholdet kan nås ved hjelp av den __doc__ attributt til objektet og bruke hjelp() metode. Måten å erklære og få tilgang til docstring i Python har vist i denne veiledningen.

Eksempel 1: Få tilgang til doktring av en funksjon ved hjelp av __doc__ Egenskap

Måten å erklære og få tilgang til doktringen til en tilpasset funksjon har vist i følgende skript. Følgende skript beregner xⁿ hvor x og n vil bli tatt fra brukeren. Makt () funksjonen har definert i skriptet for å gjøre oppgaven. Her er dokstringen definert for denne funksjonen. __doc__ attributt har blitt brukt i skriptet for å skrive ut dokstringen med utdataene.

def effekt (x, n):
"Beregn x til kraften n
Les verdiene til x og n fra funksjonsargumentene
og Beregn og returner verdien til x til kraften n."
retur x ** n
# Ta verdien av x
x = int (input ('Skriv inn verdien av x:'))
# Ta verdien av n
n = int (input ('Skriv inn verdien av n:'))
# Skriv ut returverdien til funksjonen
skriv ut ("% d til effekt% d =% d"% (x, n, effekt (x, n)))
# Skriv ut dokstringsverdien
print ("Innholdet i dokstringen: \ n" + kraft.__doc__)

Produksjon:

Følgende utdata vises når du har utført skriptet ovenfor.

Eksempel 2: Få tilgang til dokstring av klasse og metode ved hjelp av hjelp() metode

Måten å erklære og få tilgang til dokumentets doktring og metodene til denne klassen har vist i følgende skript. Skriptets hovedfunksjon er å sortere en numerisk liste og reversere dataene i listen. En numerisk liste med åtte elementer er deklarert i klassen, og doktringen er definert i begynnelsen av klassen ved å bruke trippel enkelt anførselstegn. Sort_list () -metoden er definert i klassen for å skrive ut de sorterte dataene i listen, og dokumentet har definert dette for denne metoden. omvendt liste () metoden er definert for å skrive ut listens reverserte data, og dokstringen er også definert for denne metoden. hjelp() metoden har kalt tre ganger på slutten av skriptet for å skrive ut doktringen av liste_operasjoner klasse, sort_list () metode, og omvendt liste () metode.

klasseliste_operasjoner:

klasseliste_operasjoner:
"
Sortering og reversering av listedataene
Klassen inneholder to metoder,
sort_list () -metoden sorterer og skriver ut listen,
sort_reverse () -metoden vil reversere og skrive ut listen.
"
# Definer en liste med numeriske data
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (selv):
"
Skriv ut listeverdiene etter sortering
Funksjonen tar et listeobjekt med numeriske data fra argumentet,
sortere listeverdiene ved hjelp av sort () -metoden
og skriv ut verdiene til den sorterte listen.
"
# Sorter listen
selv-.listdata.sortere()
# Skriv ut den sorterte listen ved hjelp av loop
print ("Verdiene til den sorterte listen: \ n")
for verdi i seg selv.listedata:
skriv ut (verdi, "", slutt = ")
def reverse_list (selv):
"
Skriv ut listeverdiene etter reversering
Funksjonen tar et listeobjekt med numeriske data fra argumentet,
reversere listeverdiene ved hjelp av revers-metoden
og skriv ut verdiene til den omvendte listen.
"
# Snu listen
selv-.listdata.omvendt()
# Skriv ut den omvendte listen ved hjelp av loop
print ("Verdiene til den sorterte listen: \ n")
for verdi i seg selv.listdata:
skriv ut (verdi, "", slutt = ")
# Skriv ut doktringverdien til klassen
hjelp (liste_operasjoner)
# Lag objekt av klassen
obj = liste_operasjoner ()
# Skriv ut dokstringsverdien til den bestemte metoden
hjelp (obj.sort_list)
# Ring metoden for å skrive ut den sorterte listen
obj.sort_list ()

Produksjon:

Følgende utdata vises etter utførelsen av skriptet. All doktring av manuset er skrevet ut for første gang hjelp() funksjon. Doktringen til sort_list () metoden er skrevet ut for andre gang hjelp() funksjon.

Eksempel 3: Få tilgang til dokstring av den innebygde Python-modulen

I de forrige eksemplene har dokstringen brukt i brukerdefinert klasse og funksjon. Hver innebygde Python-modul og klasse har dokstring som forklarer formålet med å bruke den aktuelle modulen eller funksjonen. Koderen til modulen eller funksjonen definerer dokstringen for å gjøre koden forståelig for brukerne. Følgende skript vil skrive ut den forhåndsdefinerte dokstringen til datetime-modulen ved å bruke hjelp() funksjon.

# Importer datetime-modul
importer datatid
# Vis doktringen for datetime
hjelp (datetime)

Produksjon:

Følgende utdata vises når du har utført skriptet. Doktringen til datetime-modulen viser detaljert dokumentasjon av den for å hjelpe de andre til å kjenne til funksjonene til klassene og metodene som er definert i denne modulen riktig.

Konklusjon:

Riktig dokumentasjon er viktig når en hvilken som helst modul eller funksjon er implementert for det spesifikke formålet for å hjelpe den andre koderen til å bruke modulen i koden til å utføre den spesifikke oppgaven. Hvis dokumentasjonen ikke er riktig definert for modulen eller funksjonen, vil de andre brukerne få problemer med å bruke den. Så alle kodere må bruke dokumentets doktring for å gi detaljert informasjon for at de andre skal forstå koden.