Python Docstring

Dokumentasjonen er avgjørende for at alle programmering enkelt kan forstå koden. Det brukes til å forklare formålet med å bruke en hvilken som helst uttalelse eller funksjon eller klasse eller modul i programmet. Det hjelper hovedkoderen med å huske funksjonen til enhver kode etter lang tid, og det hjelper også andre kodere som vil jobbe med det samme prosjektet. Koderen bruker en enkelt kommentarlinje for å forklare den spesielle delen av kodenes funksjon om kort tid. Python Document String eller DocString brukes til å forklare funksjonen til et bestemt segment av koden i detalj. DocString -linjen skal begynne med store bokstaver og slutte med en periode. Den første linjen i docstringen inneholder en kort beskrivelse av dokumentasjonen generelt. Den andre linjen i DocString skal være tom for den store flerlinje Docstring. Triple Single Quotes ('”) eller Triple Double Quotes (“” ”) brukes til å definere doktoren i python. DocString -innholdet kan nås ved bruk av __doc__ attributt til objektet og ved å bruke hjelp() metode. Måten å erklære og få tilgang til DocString i Python har vist i denne opplæringen.

Eksempel-1: Å få tilgang til docstring av en funksjon ved hjelp av __doc__ Egenskap

Måten å erklære og få tilgang til docstring av 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 docstringen blitt definert for denne funksjonen. __doc__ Attributt har blitt brukt i skriptet for å skrive ut dokumentet med utgangen.

def power (x, n):
"Beregn x til kraften n
Les verdiene til X og N fra funksjonsargumentene
og beregne og returnere verdien av x til kraften n.""
Returner x ** n
# Ta verdien av x
x = int (input ('Angi verdien av x:'))
# Ta verdien av n
n = int (input ('Angi verdien av n:'))
# Skriv ut returverdien til morsomme funksjoner
Print (" %d til strøm %d = %d" %(x, n, strøm (x, n))))
# Skriv ut DocString -verdien
Print ("Innholdet i DocString: \ n" + Power.__doc__)

Produksjon:

Følgende utdata vises etter å ha utført skriptet ovenfor.

Eksempel-2: Få tilgang til docstring av klasse og metode ved bruk av hjelp() metode

Måten å erklære og få tilgang til dokumentets doktor og metodene i den klassen har vist i følgende skript. Skriptets hovedfunksjon er å sortere en numerisk liste og reversere dataene til listen. En numerisk liste over 8 elementer er blitt erklært i klassen, og DocString er blitt definert i begynnelsen av klassen ved å bruke trippel enkelt sitater. Sort_list () -metoden er definert i klassen for å skrive ut sorterte data på listen, og dokumentet har definert dette for denne metoden. Reverse_list () Metoden er definert for å skrive ut listenes omvendte data, og DocString er også definert for denne metoden. hjelp() Metoden har ringt tre ganger på slutten av skriptet for å skrive ut dokumentet til list_operasjoner klasse, sort_list () metode, og Reverse_list () metode.

Klasseliste_operasjoner:

Klasseliste_operasjoner:
""
Sortering og reversering av listedataene
Klassen inneholder to metoder,
sort_list () -metoden vil sortere og skrive ut listen,
sort_reverse () -metoden vil reversere og skrive ut listen.
""
# Definer en liste over numeriske data
ListData = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
""
Skriv ut listeverdiene etter sortering
Funksjonen vil ta et listeobjekt av numeriske data fra argumentet,
Sorter 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 meg selv.ListData:
print (verdi, "", slutt = ")
def reverse_list (selv):
""
Skriv ut listeverdiene etter reversering
Funksjonen vil ta et listeobjekt av numeriske data fra argumentet,
Reverse listeverdiene ved å bruke omvendt () -metoden
og skriv ut verdiene på den omvendte listen.
""
# Vend listen
selv-.ListData.omvendt()
# Skriv ut den omvendte listen ved hjelp av loop
print ("Verdiene til den sorterte listen: \ n")
for verdi i meg selv.ListData:
print (verdi, "", slutt = ")
# Skriv ut dokumentverdien til klassen
hjelp (list_operasjoner)
# Lag objektet i klassen
obj = list_operasjoner ()
# Skriv ut docstring -verdien til den aktuelle metoden
hjelp (obj.sort_list)
# Ring metoden for å skrive ut den sorterte listen
obj.sort_list ()

Produksjon:

Følgende utgang vises etter å ha utført skriptet. All docstring av skriptet er skrevet ut for den første hjelp() funksjon. Dokumentet av sort_list () Metoden er skrevet ut for andre hjelp() funksjon.

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

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

# Importer DateTime Module
Importer DateTime
# Vis dokumentet av datetime
Hjelp (DateTime)

Produksjon:

Følgende utdata vises etter å ha utført skriptet. Doktoren av datetime -modulen viser den detaljerte dokumentasjonen av den for å hjelpe de andre til å kjenne funksjonene til klassene og metodene definert i denne modulen riktig.

Konklusjon:

Riktig dokumentasjon er viktig når en modul eller funksjon implementeres for det spesifikke formålet for å hjelpe den andre koderen til å bruke modulen i koden sin for å gjøre den aktuelle oppgaven. Hvis dokumentasjonen ikke er riktig definert for modulen eller funksjonen, vil de andre brukerne få problemer med å bruke den. Så hver koder må bruke dokumentets doktor for å gi detaljert informasjon for de andre for å forstå koden.