Da vi allerede ved, hvordan man skriver kommentarerne med flere linier, kan vi enten bruge de tredobbelte anførselstegn eller de tredobbelte anførselstegn. Vi bruger en dokumentationsstreng, når vi vil beskrive vores funktioner, så vi kan få dokumentationen, når vi har brug for den. Nogle IDE'er giver dig dokumentation ved blot at holde markøren over navnet, og nogle fremhæver bestemte nøgleord. Men faktum er, at docstrings i NumPy er meget mere fleksible end på andre sprog. Docstring er en streng literal, der forekommer i starten af funktionsdefinitionen. Vi skal angive specifikke værdier, mens vi bruger docstrings i tilfælde af funktioner, klasser osv.
Når vi bruger docstrings med funktioner, skal vi videregive argumenterne. Når vi bruger dem med klasser, videregiver vi attributterne og metoderne. I tilfælde af moduler skal vi levere en liste over klasser og funktioner. I tilfælde af pakken videregiver vi listen over moduler med funktionalitet. Så grundlæggende er formålet med docstringen, som navnet forklarer, at den hjælper med dokumentationen af vores kode. Vi laver dokumentation, så hvis nogen bruger vores kode i fremtiden, vil han være i stand til at forstå vores kode og logikken bag vores kode ved hjælp af docstring. Indbyggede funktioner har også docstrings i dem; vi kan bruge funktionen help() til at se på docstringen af indbyggede funktioner.
Der er nogle få forskelle mellem kommentarer og docstrings. Kommentarer ignoreres af tolke, men docstrings ignoreres ikke af tolke. Hukommelse er allokeret til docstrings. En kommentar er en beskrivelse af kode, men på den anden side fortæller docstrings os formålet med kode.
Syntaks:
Syntaksen til at skrive docstrings i NumPy er:
'''Docstring-meddelelse'''
Eller
'''Docstring besked'''
Bemærk venligst, at docstring ikke er en funktion eller metode, så den har ikke korrekt syntaks. Det eneste at bemærke her er, at vi starter docstringen med tre enkelte anførselstegn eller tre dobbelte anførselstegn. Vi skriver vores beskrivelse af koden og afslutter den igen med tre enkelte anførselstegn eller tre dobbelte anførselstegn til sidst. Der er ingen obligatoriske ting at skrive for docstrings. Du skal blot sætte tre enkelte eller dobbelte anførselstegn før og efter din strengbeskrivelse.
Eksempel 1:
For at forstå docstrings på en bedre måde, lad os udføre et eksempel. I dette eksempel, efter at have inkluderet NumPy-biblioteket, erklærer vi simpelthen variablen 'a' og en anden variabel 'b'. Derefter opretter vi vores docstring, som siger 'Lad os tilføje 'a' og 'b' variabler'. I vores tilfælde er dette et nemt eksempel, men hvis vores kode er kompleks, hjælper dette koderen meget med at forstå koden. Derefter summerer vi variablerne 'a' og 'b' og gemmer deres outputresultat i en anden variabel, som er 'c'. Til sidst udskriver vi værdien af variablen 'c'. Nu udfører vi vores kode.
importere nusset som for eksempel.-en = 1
b = to
'''Lad os tilføje a- og b-variabler'''
c = a+b
Print ( c )
Dette er vores output fra det givne stykke kode. Vi kan se, at systemet ikke har givet nogen fejl om forkert syntaks eller noget for line7 i vores kode. Desuden har systemet ikke udskrevet vores docstring. I stedet udskrev den kun outputtet af vores variabel 'c', hvor vi fortalte vores system at udskrive. Dette viser, hvordan docstrings fungerer. Næste gang, når en ny koder forsøger at arbejde på vores kode, vil han forstå, hvad vi laver ved hjælp af vores docstring. Men det vil ikke blive udskrevet som output, så brugeren af koden vil ikke blive forstyrret af det.
Eksempel 2:
Nu udfører vi et komplekst eksempel for at forstå docstringens virkemåde. Først inkluderer vi NumPy-biblioteket og skriver derefter en doc-streng, hvori vi forklarer den næste kodelinje, hvor vi forklarer initialiseringen af arrayet. Vi tilføjer også docstrings i den anden del af koden. Hvis vi nu deler denne kode med en ny Python-udvikler uden at tilføje docstrings, vil det på en eller anden måde være svært for ham at kende, hvordan denne kode fungerer og formålet. Han skal først søge efter de funktioner, vi brugte. Men hvis vi tilføjer en docstring til vores kode, vil det være nemt for de andre udviklere at forstå koden uden at studere mere om funktionerne. Vi er ikke begrænset til at tilføje kommentarer til nogle grænser; kommentarer kan være af en eller mere end én linje. Det kan også tilføjes mere end én gang i en kode. Importer derefter NumPy som np.
'''Oprettelse af den variabel, som vi vil videregive en matrix af størrelse 1x6'''array = for eksempel. array ( [ elleve , 22 , 33 , 44 , 55 , 66 ] )
'''tildele arrayet til tofile()-funktionen for at lade det gemmes i filen med navnet arr'''
array . tofil ( 'arr.bin' )
'''vis filen ved hjælp af fromfile-funktionen'''
Print ( for eksempel. fra fil ( 'arr.bin' , dtype = int ) )
Som vist i det følgende uddrag, vises docstrings ikke i outputtet, hvilket betyder, at det ikke påvirker outputtet eller kompileringen af koden. Docstrings ignoreres under kompileringsprocessen.
Konklusion
I denne guide lærte vi om docstrings i NumPy. Vi sammenlignede docstrings med kommentarer og forklarede forskellen mellem dem begge. Vi lærte syntaksen af docstrings og hvordan man skriver docstrings i vores kode. Ydermere forsøgte vi også at forklare, hvad docstrings i NumPy er, og hvordan de fungerer ved hjælp af eksempler. Til sidst bemærkede vi, at de er essentielle for kodere. Vi vil ikke gentage vigtigheden af docstrings i NumPy. Vi vil bare sige, at du skal bruge docstrings i din kode. I NumPy er skrivestilen for docstrings den mest populære. Det er meget brugt i programmeringsfællesskabet for at lade hinanden vide om deres koders funktion og funktionalitet. Denne vejledning hjælper dig med at komme i gang med NumPy docstrings. Vi forsøgte at dække det meste af det, du har brug for ved hjælp af docstrings i NumPy.