Numpy docstring

Numpy DocString er den korte formen for en numpy dokumentasjonsstreng. Numpy Docstrings gir en praktisk måte å knytte dokumentasjonen til Numpy -moduler, funksjoner, klasser og metoder. I denne guiden lærer vi hvordan du lager dokumentene i Numpy, og vi vil prøve å forstå når, hvordan og hvor de brukes. Docstrings er multi-line kommentarer i funksjoner, metoder, moduler, klasser osv. La oss forstå hva multiline kommentarer er før du lærer doktorene.

Siden vi allerede vet hvordan vi skal skrive multiline kommentarer, kan vi enten bruke trippel enkelt sitater eller trippel doble sitater. Vi bruker en dokumentasjonsstreng når vi vil beskrive funksjonene våre slik at vi kan få dokumentasjonen når vi trenger den. Noen IDE -er gir deg dokumentasjon ved bare å sveve 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 oppstår i starten av funksjonsdefinisjonen. Vi må gi spesifikke verdier mens vi bruker dokumentene i tilfeller av funksjoner, klasser osv.

Når vi bruker Docstrings med funksjoner, må vi gi argumentene. Når vi bruker dem med klasser, passerer vi attributtene og metodene. Når det gjelder moduler, må vi oppgi 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 DocString, som navnet forklarer, at det 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 seg; Vi kan bruke funksjonen til hjelp () for å se på dokumentet av innebygde funksjoner.

Det er noen få forskjeller mellom kommentarer og docstrings. Kommentarer blir ignorert av tolker, men dokumenter blir ikke ignorert av tolker. Minnet er tildelt DocStrings. En kommentar er en beskrivelse av kode, men på den annen side forteller dokumenter oss formålet med kode.

Syntaks:

Syntaksen for å skrive dokumentene i Numpy er:

"" "DocString Message" ""
Eller
"DocString Message"

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 doktoren med tre enkelt sitater eller tre doble sitater. Vi skriver beskrivelsen av koden og avslutter den igjen med tre enkelt sitater eller tre doble sitater på slutten. Det er ingen obligatorisk ting å skrive for DocStrings. Du må bare legge tre enkelt- eller dobbelt sitater før og etter strengbeskrivelsen.

Eksempel 1:

For å forstå dokumentene 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 oppretter vi doktoren vår 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 sammensatt, hjelper dette koderen mye med å forstå koden. Etter det oppsummerer vi variablene “A” og “B” og lagrer utgangen som resulterer i en annen variabel som er “C”. Til slutt skriver vi ut verdien til variabelen “C”. Nå utfører vi koden vår.

Importer numpy som NP
a = 1
B = 2
"La oss legge til A- og B -variabler"
c = a+b
trykk (c)

Dette er vår utdata fra det gitte stykke kode. Vi kan se at systemet ikke har gitt noen feil om feil syntaks eller noe for linje7 i koden vår. Systemet har heller ikke skrevet ut doktoren vår. I stedet trykket den bare utgangen fra vår variable “C” der vi ba systemet vårt skrive ut. Dette viser hvordan Docstrings 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 DocString. Men den vil ikke bli skrevet ut som utdata, slik at brukeren av koden ikke blir forstyrret av den.

Eksempel 2:

Nå utfører vi et sammensatt eksempel for å forstå doktorens arbeid. Først inkluderer vi Numpy -biblioteket og skriver deretter en DOC -streng der vi forklarer den neste kodelinjen der vi forklarer initialiseringen av matrisen. Vi legger også til dokumentene i den andre delen av koden. Nå, hvis vi deler denne koden med noen ny Python -utvikler uten å legge til Docstrings, vil det på en eller annen måte være vanskelig for ham å kjenne til arbeid og formålet med denne koden. Han må først søke om 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 av en eller flere enn en linje. Det kan også legges til mer enn en gang i en kode. Importer deretter numpy som NP.

"Opprette variabelen som vi vil passere en rekke størrelse 1x6"
Array = NP.Array ([11, 22, 33, 44, 55, 66])
"Tilordne matrisen til Tofile () -funksjonen for å la den lagret i filen som heter ARR"
Array.Tofile ("arr.BIN ")
"Vis filen ved å bruke Fromfile -funksjonen"
trykk (NP.FRAFILE ("Arr.bin ", dtype = int))

Som vist i følgende utdrag, vises ikke dokumenter i utdataene, noe som betyr at det ikke påvirker utdata eller sammenstilling av koden. DocStrings blir ignorert under kompileringsprosessen.

Konklusjon

I denne guiden lærte vi om Docstrings i Numpy. Vi sammenlignet dokumentene med kommentarer og forklarte forskjellen mellom begge. Vi lærte syntaksen til Docstrings og hvordan du skriver dokumentene i koden vår. Videre prøvde vi også å forklare hva Docstrings i Numpy er og hvordan de fungerer ved hjelp av eksempler. Til slutt bemerket vi at de er viktige for kodere. Vi vil ikke gjenta viktigheten av Docstrings i Numpy. Vi vil bare si at du bør bruke dokumentene i koden din. I Numpy er skrivestilen til Docstrings den mest populære. Det er mye brukt i programmeringssamfunnet for å gi hverandre beskjed om arbeid og funksjonalitet i kodene deres. Denne guiden vil hjelpe deg i gang med numpy docstrings. Vi prøvde å dekke det meste av det du trenger ved å bruke Docstrings i Numpy.