Siden vi allerede vet hvordan vi skal skrive kommentarene med flere linjer, kan vi enten bruke de tredoble enkle anførselstegnene eller tredoble anførselstegnene. Vi bruker en dokumentasjonsstreng når vi ønsker å beskrive funksjonene våre slik at vi kan få dokumentasjonen når vi trenger den. Noen IDE-er gir deg dokumentasjon ved å bare holde musepekeren over navnet og noen fremhever visse nøkkelord. Men faktum er at docstrings i NumPy er mye mer fleksible enn på andre språk. Docstring er en streng bokstavelig som forekommer ved starten av funksjonsdefinisjonen. Vi må oppgi spesifikke verdier mens vi bruker docstringene i tilfeller av funksjoner, klasser osv.
Når du bruker docstrings med funksjoner, må vi sende argumentene. Når vi bruker dem med klasser, passerer vi attributtene og metodene. Når det gjelder moduler, må vi gi en liste over klasser og funksjoner. Når det gjelder pakken, passerer vi listen over moduler med funksjonalitet. Så i utgangspunktet er formålet med docstringen, som navnet forklarer, at den hjelper med dokumentasjonen av koden vår. Vi gjør dokumentasjon slik at hvis noen bruker koden vår i fremtiden, vil han kunne forstå koden vår og logikken bak koden vår ved hjelp av docstring. Innebygde funksjoner har også docstrings i dem; vi kan bruke funksjonen til help() for å se på docstringen til innebygde funksjoner.
Det er noen få forskjeller mellom kommentarer og docstrings. Kommentarer ignoreres av tolker, men docstrings ignoreres ikke av tolker. Minne er allokert for docstrings. En kommentar er en beskrivelse av kode, men på den annen side forteller docstrings oss formålet med kode.
Syntaks:
Syntaksen for å skrive docstrings i NumPy er:
'''Dokstring-melding'''
Eller
'''Docstring-melding'''
Vær oppmerksom på at docstring ikke er en funksjon eller metode, så den har ikke riktig syntaks. Det eneste å merke seg her er at vi starter docstringen med tre enkle anførselstegn eller tre doble anførselstegn. Vi skriver vår beskrivelse av koden og avslutter den igjen med tre enkle anførselstegn eller tre doble anførselstegn på slutten. Det er ingen obligatoriske ting å skrive for docstrings. Du trenger bare å sette tre enkle eller doble anførselstegn før og etter strengbeskrivelsen.
Eksempel 1:
For å forstå docstringene på en bedre måte, la oss utføre et eksempel. I dette eksemplet, etter å ha inkludert NumPy-biblioteket, erklærer vi ganske enkelt variabelen 'a' og en annen variabel 'b'. Etter det lager vi vår docstring som sier 'La oss legge til 'a' og 'b' variabler'. I vårt tilfelle er dette et enkelt eksempel, men hvis koden vår er kompleks, hjelper dette koderen mye med å forstå koden. Etter det summerer vi variablene 'a' og 'b' og lagrer resultatet deres i en annen variabel som er 'c'. Til slutt skriver vi ut verdien av variabelen 'c'. Nå kjører vi koden vår.
import nusset som f.eks.en = 1
b = to
'''La oss legge til a- og b-variabler'''
c = a+b
skrive ut ( c )
Dette er vår utgang fra den gitte kodebiten. Vi kan se at systemet ikke har gitt noen feil om feil syntaks eller noe for linje 7 i koden vår. Systemet har heller ikke skrevet ut dokumentstrengen vår. I stedet skrev den bare ut utdataene til vår variabel 'c' der vi ba systemet vårt skrive ut. Dette viser hvordan docstringene fungerer. Neste gang, når en ny koder prøver å jobbe med koden vår, vil han forstå hva vi gjør ved hjelp av docstringen vår. Men den vil ikke bli skrevet ut som utdata, så brukeren av koden vil ikke bli forstyrret av den.
Eksempel 2:
Nå utfører vi et komplekst eksempel for å forstå docstringens virkemåte. Først inkluderer vi NumPy-biblioteket og skriver deretter en doc-streng der vi forklarer neste kodelinje der vi forklarer initialiseringen av matrisen. Vi legger også til docstrings i den andre delen av koden. Nå, hvis vi deler denne koden med en ny Python-utvikler uten å legge til docstrings, vil det på en eller annen måte være vanskelig for ham å vite hvordan og formålet med denne koden. Han må først søke etter funksjonene vi brukte. Men hvis vi legger til en docstring i koden vår, vil det være enkelt for de andre utviklerne å forstå koden uten å studere mer om funksjonene. Vi er ikke begrenset til å legge til kommentarer til noen grenser; kommentarer kan være på én eller flere enn én linje. Det kan også legges til mer enn én gang i en kode. Importer deretter NumPy som np.
'''Opprette variabelen som vi sender en matrise med størrelse 1x6'''array = f.eks. array ( [ elleve , 22 , 33 , 44 , 55 , 66 ] )
'''tilordne arrayen til tofile()-funksjonen for å la den lagres i filen som heter arr'''
array . å lagre ( 'arr.bin' )
'''vis filen ved å bruke fromfile-funksjonen'''
skrive ut ( f.eks. fra fil ( 'arr.bin' , dtype = int ) )
Som vist i følgende utdrag, vises ikke docstrings i utdataene, noe som betyr at det ikke påvirker utdata eller kompilering av koden. Dokumentstrenger ignoreres under kompileringsprosessen.
Konklusjon
I denne veiledningen lærte vi om docstrings i NumPy. Vi sammenlignet docstringene med kommentarer og forklarte forskjellen mellom dem begge. Vi lærte syntaksen til docstrings og hvordan man skriver docstrings i koden vår. Videre forsøkte vi også å forklare hva docstringene i NumPy er og hvordan de fungerer ved hjelp av eksempler. Til slutt bemerket vi at de er avgjørende for kodere. Vi vil ikke gjenta viktigheten av docstrings i NumPy. Vi vil bare si at du bør bruke docstrings i koden din. I NumPy er skrivestilen til docstrings den mest populære. Det er mye brukt i programmeringssamfunnet for å fortelle hverandre om hvordan kodene deres fungerer og funksjoner. Denne veiledningen hjelper deg med å komme i gang med NumPy docstrings. Vi prøvde å dekke det meste av det du trenger ved å bruke docstringene i NumPy.