Budući da već znamo kako napisati višeredne komentare, možemo koristiti trostruke jednostruke navodnike ili trostruke dvostruke navodnike. Dokumentacijski niz koristimo kada želimo opisati svoje funkcije kako bismo mogli dobiti dokumentaciju kada nam je potrebna. Neki IDE-ovi vam daju dokumentaciju tako da samo prijeđete pokazivačem iznad imena, a neki ističu određene ključne riječi. Ali činjenica je da su nizovi dokumenata u NumPyju mnogo fleksibilniji nego u drugim jezicima. Docstring je string literal koji se pojavljuje na početku definicije funkcije. Moramo osigurati specifične vrijednosti dok koristimo nizove dokumenata u slučajevima funkcija, klasa itd.
Kada koristimo nizove dokumenata s funkcijama, moramo proslijediti argumente. Kada ih koristimo s klasama, prosljeđujemo atribute i metode. U slučaju modula, moramo dati popis klasa i funkcija. U slučaju paketa, prosljeđujemo popis modula s funkcionalnošću. Dakle, u osnovi, svrha niza dokumenata je, kao što naziv objašnjava, da pomaže u dokumentaciji našeg koda. Radimo dokumentaciju tako da ako netko u budućnosti bude koristio naš kod, on će moći razumjeti naš kod i logiku iza našeg koda uz pomoć docstringa. Ugrađene funkcije također sadrže nizove dokumenata; možemo upotrijebiti funkciju help() da pogledamo docstring ugrađenih funkcija.
Postoji nekoliko razlika između komentara i nizova dokumenata. Tumači ignoriraju komentare, ali tumači ne ignoriraju nizove dokumenata. Memorija je dodijeljena nizovima dokumenata. Komentar je opis koda, ali s druge strane, nizovi dokumenata nam govore svrhu koda.
Sintaksa:
Sintaksa za pisanje nizova dokumenata u NumPy je:
'''Docstring poruka'''
Ili
'''Docstring poruka'''
Imajte na umu da docstring nije funkcija ili metoda, tako da nema ispravnu sintaksu. Jedina stvar koju ovdje treba napomenuti je da niz dokumenata započinjemo s tri jednostruka navodnika ili tri dvostruka navodnika. Napišemo naš opis koda i ponovno ga završimo s tri jednostruka navodnika ili tri dvostruka navodnika na kraju. Ne postoji obavezna stvar za pisanje nizova dokumenata. Morate samo staviti tri jednostruka ili dvostruka navodnika prije i iza opisa niza.
Primjer 1:
Da bismo bolje razumjeli nizove dokumenata, izvedimo primjer. U ovom primjeru, nakon uključivanja biblioteke NumPy, jednostavno deklariramo varijablu 'a' i drugu varijablu 'b'. Nakon toga kreiramo naš docstring koji kaže 'Dodajmo 'a' i 'b' varijable'. U našem slučaju, ovo je jednostavan primjer, ali ako je naš kod složen, to uvelike pomaže koderu u razumijevanju koda. Nakon toga zbrajamo varijable “a” i “b” i pohranjujemo njihov izlazni rezultat u drugu varijablu koja je “c”. Na kraju ispisujemo vrijednost varijable “c”. Sada izvršavamo naš kod.
uvoz numpy kao npr.a = 1
b = dva
'''Dodajmo a i b varijable'''
c = a+b
ispisati ( c )
Ovo je naš izlaz iz zadanog dijela koda. Vidimo da sustav nije dao nikakvu pogrešku o netočnoj sintaksi ili bilo čemu za liniju 7 našeg koda. Također, sustav nije ispisao naš niz dokumenata. Umjesto toga, ispisao je samo izlaz naše varijable 'c' u kojoj smo našem sustavu rekli da ispiše. Ovo pokazuje kako rade nizovi dokumenata. Sljedeći put, kada novi koder pokuša raditi na našem kodu, shvatit će što radimo uz pomoć našeg docstringa. Ali neće biti ispisan kao izlaz tako da korisnik koda neće biti uznemiren.
Primjer 2:
Sada izvodimo složen primjer kako bismo razumjeli rad niza dokumenata. Prvo uključimo NumPy biblioteku, a zatim napišemo doc string u kojem objašnjavamo sljedeću liniju koda gdje objašnjavamo inicijalizaciju niza. Također dodajemo nizove dokumenata u drugom dijelu koda. Sada, ako podijelimo ovaj kod s bilo kojim novim programerom Pythona bez dodavanja nizova dokumenata, bit će mu nekako teško znati rad i svrhu ovog koda. Prvo mora potražiti funkcije koje smo koristili. Ali ako našem kodu dodamo string dokumenta, drugim će programerima biti lako razumjeti kod bez proučavanja više o funkcijama. Nismo ograničeni na dodavanje komentara određenim ograničenjima; komentari mogu imati jedan ili više od jednog retka. Također se može dodati više puta u kod. Zatim uvezite NumPy kao np.
'''Kreiranje varijable kojoj ćemo proslijediti polje veličine 1x6'''niz = npr. niz ( [ jedanaest , 22 , 33 , 44 , 55 , 66 ] )
'''dodjeljivanje polja funkciji tofile() kako bi se spremilo u datoteku pod nazivom arr'''
niz . tofile ( 'arr.bin' )
'''prikaži datoteku pomoću funkcije fromfile'''
ispisati ( npr. iz datoteke ( 'arr.bin' , dtype = int ) )
Kao što je prikazano u sljedećem isječku, nizovi dokumenata se ne prikazuju u izlazu što znači da ne utječe na izlaz ili kompilaciju koda. Nizovi dokumenata se zanemaruju tijekom procesa kompilacije.
Zaključak
U ovom smo vodiču naučili o nizovima dokumenata u NumPyju. Usporedili smo nizove dokumenata s komentarima i objasnili razliku između njih. Naučili smo sintaksu nizova dokumenata i kako napisati nizove dokumenata u našem kodu. Nadalje, također smo uz pomoć primjera pokušali objasniti što su docstringovi u NumPyju i kako funkcioniraju. Na kraju smo napomenuli da su neophodni za programere. Nećemo ponavljati važnost nizova dokumenata u NumPyju. Samo ćemo reći da biste trebali koristiti nizove dokumenata u svom kodu. U NumPyju je stil pisanja nizova dokumenata najpopularniji. Naširoko se koristi u programerskoj zajednici kako bi jedni druge obavijestili o radu i funkcionalnosti svojih kodova. Ovaj će vam vodič pomoći da počnete s NumPy nizovima dokumenata. Pokušali smo pokriti većinu onoga što će vam trebati pomoću nizova dokumenata u NumPyju.