„Python“ instrukcija

Dokumentai yra būtini, kad bet koks programavimas lengvai suprastų kodą. Jis naudojamas paaiškinti bet kurio teiginio ar funkcijos, klasės ar modulio naudojimo programoje tikslą. Tai padeda pagrindiniam koduotojui po ilgo laiko įsiminti bet kokio kodo funkciją ir kitiems koderiams, norintiems dirbti su tuo pačiu projektu. Koderis naudoja vieną komentarų eilutę, kad trumpai paaiškintų tam tikrą kodo funkcijos dalį. „Python“ dokumento eilutė arba „docstring“ naudojama norint išsamiai paaiškinti konkretaus kodo segmento funkciją. Instrukcijos eilutė turėtų prasidėti didžiąja raide ir baigtis tašku. Pirmoje dokstringo eilutėje yra trumpas dokumentų aprašymas. Antroji dokstringo eilutė turėtų būti tuščia dideliam kelių eilučių dokstringui. Trys vienos kabutės ('') arba trigubos dvigubos kabutės („“ “) yra naudojami apibrėžiant docstring Python. Prie dokstringo turinio galima pasiekti naudojant __doc__ objekto atributas ir naudojant pagalba () metodas. Šioje pamokoje parodytas „Python“ versijos „docstring“ deklaravimo ir prieigos būdas.

1 pavyzdys: Prieiga prie funkcijos docstringo naudojant __doc__ atributas

Pasirinktinės funkcijos deklaravimo ir prieigos prie jos būdas parodytas šiame scenarijuje. Šis scenarijus apskaičiuoja xⁿ kur x ir n bus paimti iš vartotojo. Galia () Funkcija scenarijuje apibrėžė užduotį atlikti. Čia šiai funkcijai buvo nustatytas docstringas. __doc__ atributas buvo naudojamas scenarijuje atspausdinti docstring su išvestimi.

def galia (x, n):
"Apskaičiuokite x pagal galybę n
Perskaitykite x ir n reikšmes iš funkcijos argumentų
ir apskaičiuokite ir grąžinkite x reikšmę į galią n."
grįžti x ** n
# Paimkite x reikšmę
x = int (įvestis ('Įveskite x reikšmę:'))
# Paimkite n reikšmę
n = int (įvestis ('Įveskite n reikšmę:'))
# Atspausdinkite grąžinimo funkcijos vertę
spausdinti ("% d iki galios% d =% d"% (x, n, galia (x, n)))
# Atspausdinkite dokstringo vertę
spausdinti ("Dokumento eilutės turinys: \ n" + galia.__doc__)

Išvestis:

Ši išvestis bus rodoma atlikus minėtą scenarijų.

2 pavyzdys: Prieiga prie klasės ir metodo docstringo naudojant pagalba () metodas

Deklaravimo ir prieigos prie dokumento dokstringo būdas ir prieigos prie tos klasės metodai parodyti šiame scenarijuje. Pagrindinė scenarijaus funkcija yra rūšiuoti skaitinį sąrašą ir pakeisti sąrašo duomenis. Klasėje buvo paskelbtas skaitmeninis 8 elementų sąrašas, o instrukcijos eilutė buvo apibrėžta klasės pradžioje naudojant trigubas kabutes. Klasėje buvo nustatytas metodas sort_list (), kad būtų galima atsispausdinti surūšiuotus sąrašo duomenis, ir dokumentas tai apibrėžė šiam metodui. reverse_list () metodas yra apibrėžtas norint pakeisti sąrašo atvirkštinius duomenis, o šiam metodui taip pat apibrėžta docstring. pagalba () metodas skambino tris kartus scenarijaus pabaigoje, kad atspausdintų sąrašas_operacijos klasė, rūšiuoti_ sąrašą () metodas ir reverse_list () metodas.

klasės sąrašas_operacijos:

klasės sąrašas_operacijos:
"
Sąrašo duomenų rūšiavimas ir panaikinimas
Klasėje yra du metodai,
sort_list () metodas surūšiuos ir atspausdins sąrašą,
sort_reverse () metodas pakeis ir atspausdins sąrašą.
"
# Apibrėžkite skaitinių duomenų sąrašą
sąrašo duomenys = [23, 67, 23, 6, 45, 3, 90, 11]
def rūšiavimo_ sąrašas (savarankiškai):
"
Po rūšiavimo išspausdinkite sąrašo vertes
Funkcija iš argumento paims skaitinių duomenų sąrašo objektą,
rūšiuokite sąrašo vertes naudodami rūšiavimo () metodą
ir atspausdinkite surūšiuoto sąrašo reikšmes.
"
# Rūšiuoti sąrašą
savarankiškai.sąrašo duomenys.rūšiuoti ()
# Spausdinkite surūšiuotą sąrašą naudodami kilpą
spausdinti ("Rūšiuoto sąrašo vertės: \ n")
už vertę savyje.sąrašo duomenys:
spausdinti (reikšmė, "", pabaiga = ")
def reverse_list (savarankiškai):
"
Atsispausdinę sąrašo reikšmes, pasukite atgal
Funkcija iš argumento paims skaitinių duomenų sąrašo objektą,
pakeisti sąrašo vertes naudodami atvirkštinį () metodą
ir atspausdinkite atvirkštinio sąrašo reikšmes.
"
# Apverskite sąrašą
savarankiškai.sąrašo duomenys.atvirkštinis ()
# Spausdinkite atvirkštinį sąrašą naudodami kilpą
spausdinti ("Rūšiuoto sąrašo vertės: \ n")
už vertę savyje.sąrašo duomenys:
spausdinti (reikšmė, "", pabaiga = ")
# Atspausdinkite klasės instrukcijos vertę
pagalba (sąrašas_operacijos)
# Sukurkite klasės objektą
obj = sąrašas_operacijos ()
# Atspausdinkite konkretaus metodo docstring vertę
pagalba (obj.rūšiuoti_ sąrašas)
# Norėdami išspausdinti rūšiuojamą sąrašą, iškvieskite metodą
obj.rūšiuoti_ sąrašą ()

Išvestis:

Vykdant scenarijų bus rodoma ši išvestis. Pirmieji visi scenarijaus dokumentai buvo atspausdinti pagalba () funkcija. Dokstravimas rūšiuoti_ sąrašas () metodas buvo atspausdintas antrą kartą pagalba () funkcija.

3 pavyzdys: prieiga prie įmontuoto „Python“ modulio docstringo

Ankstesniuose pavyzdžiuose docstringas buvo naudojamas vartotojo apibrėžtoje klasėje ir funkcijoje. Kiekvienas įmontuotas „Python“ modulis ir klasė turi savo instrukcijas, kurios paaiškina konkretaus modulio ar funkcijos naudojimo tikslą. Modulio ar funkcijos koduotojas nustato instrukciją, kad vartotojams būtų suprantamas kodas. Šis scenarijus atspausdins iš anksto nustatytą datos laiko modulio instrukciją naudodamas pagalba () funkcija.

# Importuoti laiko ir laiko modulį
importavimo laikas
# Rodyti datos laiką
pagalba (datos laikas)

Išvestis:

Šis išvestis bus rodomas vykdant scenarijų. Datos laiko modulio instrukcija rodo išsamų jo dokumentaciją, kad kiti galėtų tinkamai žinoti šiame modulyje apibrėžtų klasių ir metodų funkcijas.

Išvada:

Tinkamas dokumentavimas yra būtinas, kai bet kuris modulis ar funkcija yra įdiegta konkrečiam tikslui, kad padėtų kitam koduotojui naudoti modulį savo kode tam tikrai užduočiai atlikti. Jei modulio ar funkcijos dokumentacija nėra tinkamai apibrėžta, kiti vartotojai susidurs su problemomis ją naudodami. Taigi, kiekvienas koduotojas turi naudoti dokumento instrukcijas, kad suteiktų išsamią informaciją kitiems, kad suprastų kodą.