Python docstring

Dokumentacija je ključna za svako programiranje da bi se lako razumjelo kod. Koristi se za objašnjenje svrhe upotrebe bilo koje izjave ili funkcije ili klase ili modula u programu. Pomaže glavnom koderu da nakon dužeg vremena zapamti funkciju bilo kojeg koda, a pomaže i ostalim koderima koji žele raditi na istom projektu. Koder koristi jedan redak komentara kako bi ukratko objasnio određeni dio funkcije koda. Niz ili docstring dokumenta Python koristi se za detaljno objašnjenje funkcije određenog segmenta koda. Redak docstrice trebao bi započeti velikim slovom, a završiti točkom. Prvi redak docstringa sadrži kratki opis dokumentacije općenito. Drugi redak docstringa trebao bi biti prazan za veliku docstring više linija. Trostruki pojedinačni navodnici ('”) ili trostruki dvostruki navodnici (“” ”) koriste se za definiranje docstringa u Pythonu. Sadržaju docstringa može se pristupiti pomoću __doc__ atribut objekta i pomoću Pomozite() metoda. Način deklariranja i pristupa docstringu u Pythonu prikazan je u ovom vodiču.

Primjer-1: Pristup docstringu funkcije pomoću __doc__ atribut

Način deklariranja i pristupa docstringu prilagođene funkcije prikazan je u sljedećoj skripti. Sljedeća skripta izračunava xⁿ gdje će se x i n uzeti od korisnika. Snaga () funkcija je u skripti definirala izvršenje zadatka. Ovdje je za ovu funkciju definirana docstring. __doc__ atribut je korišten u skripti za ispis docstringa s izlazom.

def snaga (x, n):
Msgstr "Izračunajte x do potencije n
Očitajte vrijednosti x i n iz argumenata funkcije
i izračunajte i vratite vrijednost x u snagu n."
povrat x ** n
# Uzmite vrijednost x
x = int (input ('Unesite vrijednost x:'))
# Uzmi vrijednost n
n = int (input ('Unesite vrijednost n:'))
# Ispišite povratnu vrijednost funkcije
ispis ("% d do potencije% d =% d"% (x, n, snaga (x, n)))
# Ispišite vrijednost docstringa
print ("Sadržaj docstringa: \ n" + snaga.__doc__)

Izlaz:

Sljedeći će se izlaz pojaviti nakon izvršavanja gornje skripte.

Primjer-2: Pristup docstringu klase i metode pomoću Pomozite() metoda

Način deklariranja i pristupa dokumentima dokumenta i metode te klase prikazan je u sljedećoj skripti. Glavna funkcija skripte je razvrstavanje numeričkog popisa i poništavanje podataka s popisa. Numerički popis od 8 elemenata proglašen je u klasi, a docstring je definiran na početku klase pomoću trostrukih pojedinačnih navodnika. U klasi je definirana metoda sort_list () za ispis razvrstanih podataka s popisa, a dokument je to definirao za ovu metodu. povratni_popis () metoda definirana je za ispis obrnutih podataka popisa, a za ovu je metodu definirana i docstring. Pomozite() metoda pozvala je tri puta na kraju skripte za ispis docstringa datoteke popis_operacija razred, sort_list () metoda i povratni_popis () metoda.

klasa_operacije_razreda:

klasa_operacije_razreda:
"
Sortiranje i poništavanje podataka s popisa
Predavanje sadrži dvije metode,
metoda sort_list () sortirat će i ispisati popis,
metoda sort_reverse () vratit će natrag i ispisati popis.
"
# Definirajte popis numeričkih podataka
podaci o popisu = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
"
Ispišite vrijednosti popisa nakon sortiranja
Funkcija će iz argumenta uzeti objekt popisa numeričkih podataka,
sortirajte vrijednosti popisa metodom sort ()
i ispišite vrijednosti razvrstanog popisa.
"
# Poredaj popis
sebe.listdata.vrsta()
# Ispišite sortirani popis pomoću petlje
print ("Vrijednosti razvrstanog popisa: \ n")
za vrijednost u sebi.listdata:
ispis (vrijednost, "", kraj = ")
def reverse_list (self):
"
Ispišite vrijednosti popisa nakon preokretanja
Funkcija će iz argumenta uzeti objekt popisa numeričkih podataka,
preokrenuti vrijednosti popisa metodom reverse ()
i ispisati vrijednosti obrnutog popisa.
"
# Obrni popis
sebe.listdata.obrnuti ()
# Ispišite obrnuti popis pomoću petlje
print ("Vrijednosti razvrstanog popisa: \ n")
za vrijednost u sebi.listdata:
ispis (vrijednost, "", kraj = ")
# Ispišite vrijednost docstringa klase
pomoć (popis_operacija)
# Kreirajte objekt klase
obj = popis_operacija ()
# Ispišite vrijednost docstringa određene metode
pomoć (obj.poredati_popis)
# Pozovite metodu za ispis razvrstanog popisa
obj.sort_list ()

Izlaz:

Sljedeći će se izlaz pojaviti nakon izvršavanja skripte. Sva docstring scenarija tiskana je prvi put Pomozite() funkcija. Dokumentacija sort_list () metoda tiskana je za drugu Pomozite() funkcija.

Primjer-3: Pristup docstringu ugrađenog Python modula

U prethodnim primjerima, docstring se koristio u korisnički definiranoj klasi i funkciji. Svaki ugrađeni Python modul i klasa ima svoj niz dokumenata koji objašnjava svrhu korištenja tog određenog modula ili funkcije. Kodiranje modula ili funkcije definira docstring kako bi kod bio razumljiv korisnicima. Sljedeća će skripta ispisati unaprijed definiranu docstring modula datetime pomoću Pomozite() funkcija.

# Uvoz modula za datum i vrijeme
uvoz datum i vrijeme
# Prikažite niz dokumenata datuma i vremena
pomoć (datum i vrijeme)

Izlaz:

Sljedeći će se izlaz pojaviti nakon izvršavanja skripte. Docstring modula datetime prikazuje detaljnu dokumentaciju o njemu kako bi pomogao ostalima da pravilno znaju funkcije klasa i metoda definiranih u ovom modulu.

Zaključak:

Odgovarajuća dokumentacija je bitna kada se bilo koji modul ili funkcija implementira za određenu svrhu kako bi se pomoglo drugom koderu da koristi modul u njihovom kodu za obavljanje određenog zadatka. Ako dokumentacija nije pravilno definirana za modul ili funkciju, ostali će se korisnici suočiti s problemima pri korištenju. Dakle, svaki koder mora koristiti dokumentaciju dokumenta kako bi pružio detaljne informacije ostalima kako bi razumjeli kôd.