Ker že vemo, kako napisati večvrstične komentarje, lahko uporabimo trojne enojne ali trojne dvojne narekovaje. Dokumentacijski niz uporabljamo, ko želimo opisati naše funkcije, da lahko dobimo dokumentacijo, ko jo potrebujemo. Nekateri IDE-ji vam zagotovijo dokumentacijo tako, da le s kazalcem miške premaknete nad ime, nekateri pa označijo določene ključne besede. Dejstvo pa je, da so dokumentni nizi v NumPy veliko bolj prilagodljivi kot v drugih jezikih. Docstring je nizovni literal, ki se pojavi na začetku definicije funkcije. Med uporabo nizov dokumentov moramo zagotoviti specifične vrednosti v primerih funkcij, razredov itd.
Pri uporabi nizov dokumentov s funkcijami moramo posredovati argumente. Ko jih uporabljamo z razredi, posredujemo atribute in metode. V primeru modulov moramo zagotoviti seznam razredov in funkcij. V primeru paketa posredujemo seznam modulov s funkcionalnostjo. V bistvu je namen niza dokumentov, kot razlaga ime, ta, da pomaga pri dokumentaciji naše kode. Dokumentiramo tako, da če bo nekdo v prihodnosti uporabljal našo kodo, bo lahko razumel našo kodo in logiko za našo kodo s pomočjo docstringa. Vgrajene funkcije imajo v sebi tudi nize dokumentov; lahko uporabimo funkcijo help(), da si ogledamo niz dokumentov vgrajenih funkcij.
Med komentarji in nizi dokumentov je nekaj razlik. Tolmači ignorirajo komentarje, tolmači pa ne ignorirajo nizov dokumentov. Pomnilnik je dodeljen nizom dokumentov. Komentar je opis kode, po drugi strani pa nam nizi dokumentov povedo namen kode.
Sintaksa:
Sintaksa za pisanje nizov dokumentov v NumPy je:
'''Docstring sporočilo'''
oz
'''Docstring sporočilo'''
Upoštevajte, da docstring ni funkcija ali metoda, zato nima ustrezne sintakse. Edina stvar, ki jo je treba opozoriti, je, da dokumentni niz začnemo s tremi enojnimi ali tremi dvojnimi narekovaji. Napišemo naš opis kode in ga ponovno zaključimo s tremi enojnimi ali tremi dvojnimi narekovaji na koncu. Za nize dokumentov ni obveznega zapisa. Samo tri enojne ali dvojne narekovaje morate postaviti pred in za opisom niza.
Primer 1:
Za boljše razumevanje nizov dokumentov izvedimo primer. V tem primeru po vključitvi knjižnice NumPy preprosto deklariramo spremenljivko 'a' in drugo spremenljivko 'b'. Po tem ustvarimo svoj niz dokumentov, ki pravi: »Dodajmo spremenljivki »a« in »b«. V našem primeru je to preprost primer, a če je naša koda zapletena, to koderju zelo pomaga pri razumevanju kode. Po tem seštejemo spremenljivki 'a' in 'b' in shranimo njun izhodni rezultat v drugo spremenljivko, ki je 'c'. Na koncu natisnemo vrednost spremenljivke “c”. Zdaj izvajamo našo kodo.
uvoz numpy kot npr.a = 1
b = dva
'''Dodajmo spremenljivki a in b'''
c = a+b
tiskanje ( c )
To je naš izhod iz danega dela kode. Vidimo lahko, da sistem ni dal nobene napake glede nepravilne sintakse ali česa drugega za line7 naše kode. Poleg tega sistem ni natisnil našega niza dokumentov. Namesto tega je natisnil samo izhod naše spremenljivke 'c', v kateri smo našemu sistemu naročili, naj natisne. To prikazuje, kako delujejo dokumentni nizi. Naslednjič, ko bo nov koder poskušal delati na naši kodi, bo razumel, kaj počnemo s pomočjo našega niza dokumentov. Vendar ne bo natisnjena kot izhod, tako da uporabnika kode ne bo motila.
Primer 2:
Zdaj izvedemo zapleten primer, da razumemo delovanje niza dokumentov. Najprej vključimo knjižnico NumPy in nato napišemo niz dokumenta, v katerem razložimo naslednjo vrstico kode, kjer razložimo inicializacijo matrike. V drugem delu kode dodamo tudi nize dokumentov. Zdaj, če delimo to kodo s katerim koli novim razvijalcem Pythona, ne da bi dodali nize dokumentov, mu bo nekako težko spoznati delovanje in namen te kode. Najprej mora poiskati funkcije, ki smo jih uporabljali. Če pa svoji kodi dodamo niz dokumenta, bodo drugi razvijalci preprosto razumeli kodo, ne da bi preučili več o funkcijah. Nismo omejeni na dodajanje komentarjev do nekaterih omejitev; komentarji so lahko v eni ali več vrsticah. V kodo se lahko doda tudi več kot enkrat. Nato uvozite NumPy kot np.
'''Ustvarjanje spremenljivke, ki ji bomo posredovali matriko velikosti 1x6'''niz = npr. niz ( [ enajst , 22 , 33 , 44 , 55 , 66 ] )
'''dodelitev matrike funkciji tofile(), da se shrani v datoteko z imenom arr'''
niz . tofile ( 'arr.bin' )
'''prikaži datoteko s funkcijo fromfile'''
tiskanje ( npr. iz datoteke ( 'arr.bin' , dtype = int ) )
Kot je prikazano v naslednjem izrezku, nizi dokumentov niso prikazani v izhodu, kar pomeni, da ne vpliva na izhod ali prevajanje kode. Nizi dokumentov so med postopkom prevajanja prezrti.
Zaključek
V tem priročniku smo spoznali nize dokumentov v NumPy. Primerjali smo nize dokumentov s komentarji in razložili razliko med obema. Naučili smo se sintakse nizov dokumentov in kako zapisati nize dokumentov v našo kodo. Poleg tega smo s pomočjo primerov poskušali pojasniti, kaj so dokumentni nizi v NumPy in kako delujejo. Nazadnje smo pripomnili, da so bistveni za koderje. Ne bomo ponavljali pomena nizov dokumentov v NumPy. Povedali bomo le, da bi morali uporabiti nize dokumentov v svoji kodi. V NumPy je slog pisanja nizov dokumentov najbolj priljubljen. Pogosto se uporablja v programski skupnosti, da drug drugega obveščajo o delovanju in funkcionalnosti svojih kod. Ta vodnik vam bo pomagal začeti uporabljati nize dokumentov NumPy. Z nizi dokumentov v NumPy smo poskušali pokriti večino tega, kar boste potrebovali.