Omdat we al weten hoe we de opmerkingen met meerdere regels moeten schrijven, kunnen we de drievoudige enkele aanhalingstekens of driedubbele dubbele aanhalingstekens gebruiken. We gebruiken een documentatiereeks wanneer we onze functies willen beschrijven, zodat we de documentatie kunnen krijgen wanneer we die nodig hebben. Sommige IDE's geven u documentatie door gewoon over de naam te zweven en sommige markeren bepaalde trefwoorden. Maar het feit is dat docstrings in NumPy veel flexibeler zijn dan in andere talen. Docstring is een letterlijke tekenreeks die voorkomt aan het begin van de functiedefinitie. We moeten specifieke waarden opgeven tijdens het gebruik van de docstrings in het geval van functies, klassen, enz.
Bij het gebruik van docstrings met functies, moeten we de argumenten doorgeven. Wanneer we ze gebruiken met klassen, geven we de attributen en methoden door. In het geval van Modules moeten we een lijst met klassen en functies verstrekken. In het geval van het pakket passeren we de lijst met modules met functionaliteit. Dus eigenlijk is het doel van de docstring, zoals de naam al aangeeft, dat het helpt bij de documentatie van onze code. We doen documentatie zodat als iemand onze code in de toekomst gebruikt, hij onze code en de logica achter onze code kan begrijpen met behulp van docstring. Ingebouwde functies hebben ook docstrings; we kunnen de functie van help() gebruiken om naar de docstring van ingebouwde functies te kijken.
Er zijn een paar verschillen tussen opmerkingen en docstrings. Opmerkingen worden genegeerd door tolken, maar docstrings worden niet genegeerd door tolken. Er wordt geheugen toegewezen voor docstrings. Een opmerking is een beschrijving van code, maar aan de andere kant vertellen docstrings ons het doel van code.
Syntaxis:
De syntaxis om de docstrings in NumPy te schrijven is:
'''Docstring bericht'''
Of
'''Docstring bericht'''
Houd er rekening mee dat docstring geen functie of methode is, dus het heeft geen juiste syntaxis. Het enige dat hier moet worden opgemerkt, is dat we de docstring beginnen met drie enkele aanhalingstekens of drie dubbele aanhalingstekens. We schrijven onze beschrijving van de code en eindigen deze opnieuw met drie enkele aanhalingstekens of drie dubbele aanhalingstekens aan het einde. Er is niets verplicht om te schrijven voor docstrings. Je hoeft alleen maar drie enkele of dubbele aanhalingstekens voor en na je tekenreeksbeschrijving te plaatsen.
Voorbeeld 1:
Laten we een voorbeeld geven om de docstrings op een betere manier te begrijpen. In dit voorbeeld declareren we, na het opnemen van de NumPy-bibliotheek, eenvoudig de variabele 'a' en een andere variabele 'b'. Daarna maken we onze docstring die zegt: 'Laten we 'a' en 'b' variabelen toevoegen'. In ons geval is dit een eenvoudig voorbeeld, maar als onze code complex is, helpt dit de codeur veel bij het begrijpen van de code. Daarna tellen we de variabelen 'a' en 'b' op en slaan hun uitvoerresultaat op in een andere variabele die 'c' is. Ten slotte drukken we de waarde van de variabele 'c' af. Nu voeren we onze code uit.
importeren numpy net zo bijv.a = 1
b = twee
'''Laten we a en b variabelen toevoegen'''
c = a+b
afdrukken ( c )
Dit is onze output van het gegeven stuk code. We kunnen zien dat het systeem geen enkele fout heeft gegeven over een onjuiste syntaxis of iets anders voor regel 7 van onze code. Ook heeft het systeem onze docstring niet afgedrukt. In plaats daarvan heeft het alleen de uitvoer van onze variabele 'c' afgedrukt waarin we ons systeem hebben verteld om af te drukken. Dit laat zien hoe de docstrings werken. De volgende keer, wanneer een nieuwe codeur aan onze code probeert te werken, zal hij begrijpen wat we doen met behulp van onze docstring. Maar het wordt niet afgedrukt als uitvoer, dus de gebruiker van de code zal er geen last van hebben.
Voorbeeld 2:
Nu voeren we een complex voorbeeld uit om de werking van de docstring te begrijpen. Eerst nemen we de NumPy-bibliotheek op en schrijven vervolgens een doc-tekenreeks waarin we de volgende regel code uitleggen waarin we de initialisatie van de array uitleggen. We voegen ook de docstrings toe in het andere deel van de code. Als we deze code nu delen met een nieuwe Python-ontwikkelaar zonder de docstrings toe te voegen, zal het op de een of andere manier moeilijk voor hem zijn om de werking en het doel van deze code te kennen. Hij moet eerst zoeken naar de functies die we hebben gebruikt. Maar als we een docstring aan onze code toevoegen, zullen de andere ontwikkelaars de code gemakkelijk kunnen begrijpen zonder meer over de functies te bestuderen. We zijn niet beperkt tot het toevoegen van opmerkingen aan sommige limieten; opmerkingen kunnen van één of meer dan één regel zijn. Het kan ook meer dan één keer in een code worden toegevoegd. Importeer vervolgens NumPy als np.
'''De variabele maken waaraan we een array met de grootte 1x6 zullen doorgeven'''reeks = bijv. reeks ( [ elf , 22 , 33 , 44 , 55 , 66 ] )
'''de array toewijzen aan de functie tofile() om deze te laten opslaan in het bestand met de naam arr'''
reeks . tofile ( 'arr.bin' )
'''het bestand weergeven met de functie fromfile'''
afdrukken ( bijv. van bestand ( 'arr.bin' , dtype = int ) )
Zoals te zien is in het volgende fragment, worden docstrings niet weergegeven in de uitvoer, wat betekent dat dit geen invloed heeft op de uitvoer of compilatie van de code. Docstrings worden genegeerd tijdens het compilatieproces.
Conclusie
In deze handleiding hebben we geleerd over docstrings in NumPy. We vergeleken de docstrings met opmerkingen en legden het verschil tussen beide uit. We hebben de syntaxis van docstrings geleerd en hoe we de docstrings in onze code moeten schrijven. Verder hebben we met behulp van voorbeelden ook geprobeerd uit te leggen wat de docstrings in NumPy zijn en hoe ze werken. Ten slotte merkten we op dat ze essentieel zijn voor codeurs. We zullen het belang van docstrings in NumPy niet herhalen. We zullen alleen zeggen dat je de docstrings in je code moet gebruiken. In NumPy is de schrijfstijl van docstrings de meest populaire. Het wordt veel gebruikt in de programmeergemeenschap om elkaar te informeren over de werking en functionaliteit van hun codes. Deze handleiding helpt u aan de slag te gaan met NumPy docstrings. We hebben geprobeerd het meeste van wat je nodig hebt te dekken met behulp van de docstrings in NumPy.