Kadangi jau žinome, kaip rašyti kelių eilučių komentarus, galime naudoti arba trigubas viengubas, arba trigubas dvigubas kabutes. Naudojame dokumentacijos eilutę, kai norime apibūdinti savo funkcijas, kad galėtume gauti dokumentaciją, kai jos prireiks. Kai kurie IDE pateikia dokumentus tiesiog užvesdami pelės žymeklį virš pavadinimo, o kai kurie paryškina tam tikrus raktinius žodžius. Tačiau faktas yra tas, kad „NumPy“ dokumentų eilutės yra daug lankstesnės nei kitomis kalbomis. Docsstring yra eilutės raidė, atsirandanti funkcijos apibrėžimo pradžioje. Naudodami dokumentų eilutes funkcijų, klasių ir pan. atvejais, turime pateikti konkrečias reikšmes.
Naudodami dokumentų eilutes su funkcijomis, turime perduoti argumentus. Naudodami juos su klasėmis, perduodame atributus ir metodus. Modulių atveju turime pateikti klasių ir funkcijų sąrašą. Paketo atveju perduodame modulių su funkcionalumu sąrašą. Taigi iš esmės, kaip paaiškina pavadinimas, dokumento eilutės tikslas yra padėti dokumentuoti mūsų kodą. Mes rengiame dokumentaciją, kad jei kas nors ateityje naudotų mūsų kodą, jis galėtų suprasti mūsų kodą ir kodo logiką naudodamas docstring. Integruotose funkcijose taip pat yra dokumentų eilutės; galime naudoti funkciją help() norėdami peržiūrėti integruotų funkcijų eilutę.
Yra keletas skirtumų tarp komentarų ir dokumentų eilutės. Vertėjai nepaiso komentarų, bet vertėjai neignoruoja dokumentų. Atmintis yra skirta dokumentų eilutėms. Komentaras yra kodo aprašymas, tačiau, kita vertus, dokumentų eilutės nurodo kodo paskirtį.
Sintaksė:
Sintaksė, skirta numPy dokumentų eilutėms rašyti:
'''Dokumentų eilutės pranešimas'''
Arba
''Dokumentų eilutės pranešimas''
Atminkite, kad dokumentų eilutė nėra funkcija ar metodas, todėl ji neturi tinkamos sintaksės. Vienintelis dalykas, į kurį reikia atkreipti dėmesį, yra tai, kad dokumentų eilutę pradedame trimis viengubomis kabutėmis arba trimis dvigubomis kabutėmis. Rašome savo kodo aprašymą ir vėl užbaigiame trimis viengubomis kabutėmis arba trimis dvigubomis kabutėmis. Nėra privalomo dalyko, kurį reikia rašyti dokumentams. Prieš ir po eilutės aprašymo tereikia įdėti tris viengubas arba dvigubas kabutes.
1 pavyzdys:
Norėdami geriau suprasti dokumentų eilutes, pateiksime pavyzdį. Šiame pavyzdyje, įtraukę NumPy biblioteką, mes tiesiog deklaruojame kintamąjį 'a' ir kitą kintamąjį 'b'. Po to sukuriame dokumentų eilutę, kuri sako: „Pridėkime „a“ ir „b“ kintamuosius“. Mūsų atveju tai yra paprastas pavyzdys, tačiau jei mūsų kodas yra sudėtingas, tai labai padeda programuotojui suprasti kodą. Po to susumuojame kintamuosius „a“ ir „b“ ir išsaugome jų išvesties rezultatą kitame kintamajame, kuris yra „c“. Galiausiai išspausdiname kintamojo „c“ reikšmę. Dabar vykdome savo kodą.
importuoti nelygus kaip pvz.a = 1
b = du
''''Pridėkime a ir b kintamuosius''
c = a+b
spausdinti ( c )
Tai mūsų išvestis iš nurodyto kodo. Matome, kad sistema nepateikė jokios klaidos dėl neteisingos sintaksės ar nieko mūsų kodo 7 eilutėje. Be to, sistema neatspausdino mūsų dokumentų eilutės. Vietoj to, jis išspausdino tik mūsų kintamojo „c“ išvestį, kurioje nurodėme sistemai spausdinti. Tai parodo, kaip veikia dokumentai. Kitą kartą, kai naujas programuotojas bandys dirbti su mūsų kodu, jis supras, ką mes darome, naudodamas savo dokumentų eilutę. Tačiau jis nebus išspausdintas kaip išvestis, todėl kodo naudotojas tai netrukdys.
2 pavyzdys:
Dabar pateikiame sudėtingą pavyzdį, kad suprastume, kaip veikia dokumentų eilutė. Pirma, įtraukiame NumPy biblioteką ir tada parašome doc eilutę, kurioje paaiškiname kitą kodo eilutę, kurioje paaiškiname masyvo inicijavimą. Dokumentų eilutes taip pat pridedame kitoje kodo dalyje. Dabar, jei pasidalinsime šiuo kodu su bet kokiu nauju Python kūrėju nepridėdami dokumentų stygų, jam bus kažkaip sunku žinoti šio kodo veikimą ir paskirtį. Pirmiausia jis turi ieškoti funkcijų, kurias naudojome. Bet jei prie savo kodo pridėsime dokumento eilutę, kitiems kūrėjams bus lengva suprasti kodą, nesimokant daugiau apie funkcijas. Mes neapsiribojame komentarų pridėjimu iki tam tikrų apribojimų; komentarai gali būti vienos arba daugiau nei vienos eilutės. Jis taip pat gali būti įtrauktas į kodą daugiau nei vieną kartą. Tada importuokite NumPy kaip np.
''''Kintamojo sukūrimas, kuriam perduosime 1x6 dydžio masyvą'''masyvas = pvz. masyvas ( [ vienuolika , 22 , 33 , 44 , 55 , 66 ] )
''''masyvo priskyrimas funkcijai tofile(), kad jis būtų išsaugotas faile pavadinimu arr'''
masyvas . į failą ( 'arr.bin' )
''Rodyti failą naudojant funkciją fromfile'''
spausdinti ( pvz. iš failo ( 'arr.bin' , dtipas = tarpt ) )
Kaip parodyta toliau pateiktame fragmente, dokumentų eilutės nerodomos išvestyje, o tai reiškia, kad tai neturi įtakos kodo išvesties ar kompiliavimo rezultatams. Kompiliavimo proceso metu dokumentų eilutės nepaisomos.
Išvada
Šiame vadove sužinojome apie „NumPy“ dokumentų eilutes. Mes palyginome dokumentų eilutes su komentarais ir paaiškinome skirtumą tarp jų. Išmokome dokumentų eilučių sintaksę ir kaip rašyti eilutes savo kode. Be to, naudodamiesi pavyzdžiais taip pat bandėme paaiškinti, kas yra „NumPy“ dokumentų eilutės ir kaip jos veikia. Galiausiai pažymėjome, kad jie yra būtini koduotojams. Mes nekartosime docstring svarbos NumPy. Mes tiesiog pasakysime, kad savo kode turėtumėte naudoti dokumentų eilutes. „NumPy“ docstring rašymo stilius yra populiariausias. Jis plačiai naudojamas programavimo bendruomenėje, kad praneštų vieni kitiems apie savo kodų veikimą ir funkcionalumą. Šis vadovas padės jums pradėti naudoti „NumPy“ dokumentų eilutes. Pabandėme aprėpti didžiąją dalį to, ko jums prireiks, naudodami „NumPy“ dokumentų eilutes.