Pythoni käsklus

Dokumentatsioon on hädavajalik, et kõik programmeerimised saaksid koodist hõlpsasti aru. Seda kasutatakse selleks, et selgitada mis tahes lause või funktsiooni, klassi või mooduli kasutamise eesmärki programmis. See aitab peamisel kodeerijal pika aja jooksul meelde jätta mis tahes koodi funktsiooni ja aitab ka teisi koodereid, kes soovivad sama projektiga töötada. Kooder kasutab ühe kommentaarirea abil koodi konkreetse osa lühikest selgitamist. Pythoni dokumendistringi või docstringi kasutatakse koodi konkreetse segmendi funktsiooni üksikasjalikuks selgitamiseks. Dokstringirida peaks algama suurtähega ja lõppema punktiga. Dokstringi esimene rida sisaldab üldiselt dokumentatsiooni lühikirjeldust. Dokstringi teine ​​rida peaks suure mitmerealise docstringi jaoks olema tühi. Kolmekordsed jutumärgid ('") või kolmekordsed jutumärgid (“” ”) kasutatakse käskude defineerimiseks Pythonis. Dokstringi sisule pääseb juurde kasutades __doc__ objekti atribuut ja abi () meetod. Selles õpetuses on näidatud Pythonis docstringide deklareerimise ja neile juurdepääsu viis.

Näide 1: Funktsiooni docstringile juurdepääs kasutades __doc__ atribuut

Kohandatud funktsiooni docstringile deklareerimise ja sellele juurdepääsu viis on näidatud järgmises skriptis. Järgmine skript arvutab xⁿ kus x ja n võetakse kasutajalt. Võimsus () funktsioon on skripti ülesande täitmiseks määratletud. Siin on selle funktsiooni jaoks defineeritud käskstring. __doc__ atribuuti on skriptis kasutatud väljundiga docstringi printimiseks.

def võimsus (x, n):
"Arvutage x võimsuseks n
Loe funktsioonide argumentidest x ja n väärtused
ning arvutage ja tagastage x väärtus võimsuseks n."
tagastus x ** n
# Võtke x väärtus
x = int (sisend ('Sisestage x väärtus:'))
# Võtke n väärtus
n = int (sisend ('Sisestage n väärtus:'))
# Trükkige funktsiooni tagastusväärtus
print ("% d võimsuseni% d =% d"% (x, n, võimsus (x, n)))
# Printige käsu väärtus
print ("Dokstringi sisu: \ n" + võimsus.__doc__)

Väljund:

Pärast ülaltoodud skripti käivitamist ilmub järgmine väljund.

Näide 2: Juurdepääs klassi ja meetodi käsureale kasutades abi () meetod

Dokumendi käskude deklareerimise ja sellele juurdepääsu viis ning selle klassi meetodid on näidatud järgmises skriptis. Skripti põhifunktsioon on numbrilise loendi sortimine ja loendi andmete vastupidine muutmine. Klassis on deklareeritud 8 elemendist koosnev arvuline loend ja instruktsioon on klassi alguses määratletud kolmekordsete jutumärkide abil. Klassis sorteeritud andmete printimiseks on klassis määratletud meetod sort_list () ja dokument on selle määratlenud selle meetodi jaoks. reverse_list () meetod on määratletud loendi vastupidiste andmete printimiseks ja selle meetodi jaoks on määratletud ka käskstring. abi () meetod on skripti lõpus kolm korda helistanud, et printida nimekiri_operatsioonid klass, sort_list () meetod ja reverse_list () meetod.

klassi nimekirjaoperatsioonid:

klassi nimekirjaoperatsioonid:
"
Loendiandmete sortimine ja tagurdamine
Klass sisaldab kahte meetodit,
sort_list () meetod sorteerib ja prindib loendi,
sort_reverse () meetod muudab loendi vastupidiseks ja prindib.
"
# Määratlege arvandmete loend
loendiandmed = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (ise):
"
Pärast sortimist printige loendi väärtused
Funktsioon võtab argumendist arvandmete loendiobjekti,
sortige loendi väärtused sort () meetodi abil
ja printige sorditud loendi väärtused.
"
# Sorteeri loend
ise.listdata.sort ()
# Trükkige sorditud loend silmusega
print ("Sorteeritud loendi väärtused: \ n")
väärtuse jaoks iseendas.listdata:
print (väärtus, "", lõpp = ")
def reverse_list (ise):
"
Pärast tagurdamist printige loendi väärtused
Funktsioon võtab argumendist arvandmete loendiobjekti,
loendiväärtused pöörata vastupidise () meetodi abil
ja printige pöördloendi väärtused.
"
# Pöörake loend ümber
ise.listdata.tagurpidi()
# Trükkige vastupidine loend silmusega
print ("Sorteeritud loendi väärtused: \ n")
väärtuse jaoks iseendas.listdata:
print (väärtus, "", lõpp = ")
# Trükkige klassi docstring väärtus
abi (nimekiri_operatsioonid)
# Loo klassi objekt
obj = nimekirjaoperatsioonid ()
# Trükkige konkreetse meetodi käsu väärtus
abi (obj.sort_list)
# Sorteeritud loendi printimiseks helistage meetodile
obj.sort_list ()

Väljund:

Pärast skripti käivitamist ilmub järgmine väljund. Esimesena on trükitud kogu skripti juhend abi () funktsioon. Dokstring sort_list () meetodi jaoks on trükitud teine abi () funktsioon.

Näide 3: Juurdepääs sisseehitatud Pythoni mooduli docstringile

Eelmistes näidetes on docstringi kasutatud kasutaja määratud klassis ja funktsioonis. Igal sisseehitatud Pythoni moodulil ja klassil on oma käsk, mis selgitab konkreetse mooduli või funktsiooni kasutamise eesmärki. Mooduli või funktsiooni kooder määratleb käsu, et muuta kood kasutajatele arusaadavaks. Järgmine skript trükib kuupäeva-aja mooduli eelnevalt määratletud käsu, kasutades abi () funktsioon.

# Impordi kuupäevaaja moodul
impordi kuupäev
# Kuva kuupäeva kellaajade käsk
abi (kuupäeva aeg)

Väljund:

Pärast skripti käivitamist ilmub järgmine väljund. Kuupäevaaja mooduli käsk näitab selle üksikasjalikku dokumentatsiooni, et aidata teistel selles moodulis määratletud klasside ja meetodite funktsioone õigesti tunda.

Järeldus:

Nõuetekohane dokumentatsioon on hädavajalik, kui mis tahes moodul või funktsioon on rakendatud konkreetsel eesmärgil, et aidata teisel kodeerijal kasutada moodulit oma koodis konkreetse ülesande täitmiseks. Kui dokumentatsioon pole mooduli või funktsiooni jaoks õigesti määratletud, on teistel kasutajatel selle kasutamisel probleeme. Seega peab iga kooder kasutama dokumendi käske, et pakkuda teistele üksikasjalikku teavet koodi mõistmiseks.