Eftersom vi redan vet hur man skriver flerradskommentarerna kan vi antingen använda trippel enkla citattecken eller trippel dubbla citattecken. Vi använder en dokumentationssträng när vi vill beskriva våra funktioner så att vi kan få dokumentationen när vi behöver den. Vissa IDE:er ger dig dokumentation genom att bara hålla muspekaren över namnet och vissa markerar vissa nyckelord. Men faktum är att docstrings i NumPy är mycket mer flexibla än på andra språk. Docstring är en bokstavlig sträng som förekommer i början av funktionsdefinitionen. Vi måste tillhandahålla specifika värden när vi använder docstrings i fall av funktioner, klasser etc.
När vi använder docstrings med funktioner måste vi skicka argumenten. När vi använder dem med klasser skickar vi attributen och metoderna. När det gäller moduler måste vi tillhandahålla en lista över klasser och funktioner. När det gäller paketet passerar vi listan över moduler med funktionalitet. Så i grund och botten är syftet med docstringen, som namnet förklarar, att den hjälper till med dokumentationen av vår kod. Vi gör dokumentation så att om någon använder vår kod i framtiden så ska denne kunna förstå vår kod och logiken bakom vår kod med hjälp av docstring. Inbyggda funktioner har också docstrings i dem; vi kan använda funktionen help() för att titta på docstringen av inbyggda funktioner.
Det finns några skillnader mellan kommentarer och docstrings. Kommentarer ignoreras av tolkar men docstrings ignoreras inte av tolkar. Minne tilldelas för docstrings. En kommentar är en beskrivning av kod, men å andra sidan berättar docstrings oss syftet med koden.
Syntax:
Syntaxen för att skriva docstrings i NumPy är:
'''Docstring meddelande'''
Eller
'''Docstring meddelande'''
Observera att docstring inte är en funktion eller metod, så den har inte korrekt syntax. Det enda att notera här är att vi börjar docstringen med tre enkla citattecken eller tre dubbla citattecken. Vi skriver vår beskrivning av koden och avslutar den igen med tre enkla citattecken eller tre dubbla citattecken i slutet. Det finns inget obligatoriskt att skriva för docstrings. Du behöver bara sätta tre enkla eller dubbla citattecken före och efter din strängbeskrivning.
Exempel 1:
För att förstå docstrings på ett bättre sätt, låt oss utföra ett exempel. I det här exemplet, efter att ha tagit med NumPy-biblioteket, deklarerar vi helt enkelt variabeln 'a' och en annan variabel 'b'. Efter det skapar vi vår docstring som säger 'Låt oss lägga till 'a' och 'b' variabler. I vårt fall är detta ett enkelt exempel men om vår kod är komplex hjälper detta kodaren mycket att förstå koden. Därefter summerar vi variablerna 'a' och 'b' och lagrar deras utdata i en annan variabel som är 'c'. Slutligen skriver vi ut värdet på variabeln 'c'. Nu kör vi vår kod.
importera numpy som t.ex.a = 1
b = två
'''Låt oss lägga till a- och b-variabler'''
c = a+b
skriva ut ( c )
Detta är vår utdata från den givna kodbiten. Vi kan se att systemet inte har gett något fel om felaktig syntax eller något för line7 i vår kod. Systemet har inte heller skrivit ut vår docstring. Istället skrev den bara ut utdata från vår variabel 'c' där vi sa till vårt system att skriva ut. Detta visar hur docstrings fungerar. Nästa gång, när en ny kodare försöker arbeta med vår kod, kommer han att förstå vad vi gör med hjälp av vår docstring. Men den kommer inte att skrivas ut som utdata så användaren av koden kommer inte att störas av den.
Exempel 2:
Nu utför vi ett komplext exempel för att förstå hur docstringen fungerar. Först inkluderar vi NumPy-biblioteket och skriver sedan en doc-sträng där vi förklarar nästa kodrad där vi förklarar initieringen av arrayen. Vi lägger också till docstrings i den andra delen av koden. Om vi nu delar den här koden med någon ny Python-utvecklare utan att lägga till docstrings, kommer det på något sätt att vara svårt för honom att veta hur den här koden fungerar och syftet. Han måste först söka efter funktionerna som vi använde. Men om vi lägger till en docstring i vår kod blir det lätt för de andra utvecklarna att förstå koden utan att studera mer om funktionerna. Vi är inte begränsade till att lägga till kommentarer till vissa gränser; kommentarer kan vara av en eller flera rader. Det kan också läggas till mer än en gång i en kod. Importera sedan NumPy som np.
'''Skapa variabeln till vilken vi skickar en array med storleken 1x6'''array = t.ex. array ( [ elva , 22 , 33 , 44 , 55 , 66 ] )
'''tilldelar arrayen till tofile()-funktionen för att låta den sparas i filen med namnet arr'''
array . tofil ( 'arr.bin' )
'''visa filen med funktionen fromfile'''
skriva ut ( t.ex. från fil ( 'arr.bin' , dtype = int ) )
Som visas i följande utdrag visas inte docstrings i utdata, vilket betyder att det inte påverkar utdata eller kompilering av koden. Docstrings ignoreras under kompileringsprocessen.
Slutsats
I den här guiden lärde vi oss om docstrings i NumPy. Vi jämförde docstrings med kommentarer och förklarade skillnaden mellan dem båda. Vi lärde oss syntaxen för docstrings och hur man skriver docstrings i vår kod. Vidare försökte vi också förklara vad docstrings i NumPy är och hur de fungerar med hjälp av exempel. Slutligen påpekade vi att de är viktiga för kodare. Vi kommer inte att upprepa vikten av docstrings i NumPy. Vi säger bara att du ska använda docstrings i din kod. I NumPy är skrivstilen för docstrings den mest populära. Det används ofta i programmeringscommunityt för att låta varandra veta om deras koders funktion och funktionalitet. Den här guiden hjälper dig att komma igång med NumPy docstrings. Vi försökte täcka det mesta du behöver med hjälp av docstrings i NumPy.