Python docstring

Dokumentacija je bistvenega pomena za vsako programiranje, da lahko kode enostavno razume. Uporablja se za razlago namena uporabe katerega koli stavka ali funkcije ali razreda ali modula v programu. Glavnemu kodirniku pomaga, da si po dolgem času zapomni funkcijo katere koli kode, pomaga pa tudi drugim kodirnikom, ki želijo delati na istem projektu. Programer uporablja eno vrstico komentarja, da v kratkem razloži določen del funkcije kode. Niz ali dokumentni niz Python se uporablja za podrobno razlago funkcije določenega segmenta kode. Vrstica dokumentov naj se začne z veliko začetnico in konča s piko. Prva vrstica dokumenta vsebuje kratek opis dokumentacije na splošno. Druga vrstica docstringa mora biti prazna za velik večvrstični docstring. Trojni enojni narekovaji ('”) ali trojni dvojni narekovaji (“” ”) se uporabljajo za definiranje docstringa v Pythonu. Do vsebine dokumentov je mogoče dostopati z uporabo __doc__ atribut predmeta in z uporabo pomoč () metoda. V tej vadnici je prikazan način prijave in dostopanja do dokumentov v Pythonu.

Primer-1: Dostop do dokumentacije funkcije z uporabo __doc__ atribut

Način prijave in dostopa do dokumentacije funkcije po meri je prikazan v naslednjem skriptu. Naslednji skript izračuna xⁿ kjer bosta uporabniku vzeta x in n. Moč () funkcija je v skriptu definirala nalogo. Tu je bil za to funkcijo definiran dokumentni niz. __doc__ atribut je bil v skriptu uporabljen za tiskanje docstringa z izhodnimi podatki.

def moč (x, n):
"Izračunaj x na moč n
Preberite vrednosti x in n iz argumentov funkcije
in izračunajte in vrnite vrednost x v moč n."
vrnitev x ** n
# Vzemite vrednost x
x = int (vnos ('Vnesite vrednost x:'))
# Vzemite vrednost n
n = int (vnos ('Vnesite vrednost n:'))
# Natisnite vrnjeno vrednost funkcije
print ("% d do stopnje% d =% d"% (x, n, moč (x, n)))
# Natisnite vrednost docstringa
print ("Vsebina docstringa: \ n" + moč.__doc__)

Izhod:

Naslednji izhod se bo prikazal po izvedbi zgornjega skripta.

Primer-2: Dostop do dokumentov vrste in metode z uporabo pomoč () metoda

Način deklariranja in dostopa do dokumentov in metode tega razreda je prikazan v naslednjem skriptu. Glavna funkcija skripta je razvrščanje številskega seznama in obračanje podatkov seznama. V razredu je bil razglašen številski seznam 8 elementov, docstring pa je bil definiran na začetku razreda z uporabo trojnih enojnih narekovajev. V razredu je bila določena metoda sort_list () za tiskanje razvrščenih podatkov seznama, dokument pa je to določil za to metodo. reverse_list () metoda je definirana za tiskanje obrnjenih podatkov seznama, za to metodo pa je določen tudi dokumentni niz. pomoč () metoda je na koncu skripta trikrat poklicala, da natisne vrvico datoteke seznam_operacij razred, sort_list () metoda in reverse_list () metoda.

class list_operations:

class list_operations:
"
Razvrščanje in spreminjanje podatkov seznama
Predavanje vsebuje dve metodi,
metoda sort_list () bo sortirala in natisnila seznam,
metoda sort_reverse () bo obrnila in natisnila seznam.
"
# Določite seznam numeričnih podatkov
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
"
Po razvrščanju natisnite vrednosti seznama
Funkcija bo iz argumenta vzela predmet s številskimi podatki,
razvrstite vrednosti seznama z uporabo metode sort ()
in natisnite vrednosti razvrščenega seznama.
"
# Razvrsti seznam
sebe.listdata.razvrsti ()
# S pomočjo zanke natisnite razvrščeni seznam
print ("Vrednosti razvrščenega seznama: \ n")
za vrednost v sebi.listdata:
tisk (vrednost, "", konec = ")
def reverse_list (self):
"
Natisnite vrednosti seznama po vzvratni vožnji
Funkcija bo iz argumenta vzela objekt s številskimi podatki,
obrnite vrednosti seznama z uporabo metode reverse ()
in natisnite vrednosti obrnjenega seznama.
"
# Obrni seznam
sebe.listdata.vzvratno ()
# Natisnite obrnjeni seznam z zanko
print ("Vrednosti razvrščenega seznama: \ n")
za vrednost v sebi.listdata:
tiskanje (vrednost, "", konec = ")
# Natisnite vrednost dokumenta v razredu
pomoč (seznam_operacij)
# Ustvari objekt razreda
obj = seznam_operacij ()
# Natisnite vrednost docstringa določene metode
pomoč (obj.sort_list)
# Pokličite metodo za tiskanje razvrščenega seznama
obj.sort_list ()

Izhod:

Po izvedbi skripta se prikaže naslednji izhod. Vsi docstringi skripta so natisnjeni prvič pomoč () funkcijo. Dokumentacija sort_list () metoda je bila natisnjena za drugo pomoč () funkcijo.

Primer-3: Dostop do dokumentov vgrajenega modula Python

V prejšnjih primerih je docstring uporabljen v uporabniško določenem razredu in funkciji. Vsak vgrajeni modul in razred Python ima svoj dokument, ki pojasnjuje namen uporabe tega modula ali funkcije. Kodiranje modula ali funkcije definira vrvico dokumentov, da bo koda razumljiva uporabnikom. Naslednji skript bo natisnil vnaprej določen dokumentni modul datuma in časa z uporabo pomoč () funkcijo.

# Uvozi modul datuma in časa
uvozi datum in čas
# Prikažite vrstico z datumom in časom
pomoč (datum in čas)

Izhod:

Po izvedbi skripta se prikaže naslednji izhod. Dokumentacija modula datuma in časa prikazuje njegovo podrobno dokumentacijo, s katero bodo ostali lažje spoznali funkcije razredov in metod, opredeljenih v tem modulu.

Zaključek:

Pravilna dokumentacija je bistvenega pomena, kadar je katerikoli modul ali funkcija implementirana za določen namen, da pomaga drugemu kodirniku, da uporablja modul v njihovi kodi za izvajanje določene naloge. Če dokumentacija ni pravilno definirana za modul ali funkcijo, bodo drugi uporabniki imeli težave z uporabo. Torej, vsak kodirnik mora uporabiti dokumentno dokumentacijo, da drugim zagotovi podrobne informacije za razumevanje kode.