Mivel már tudjuk, hogyan kell írni a többsoros megjegyzéseket, használhatjuk a hármas szimpla idézőjeleket vagy a hármas kettős idézőjeleket. Dokumentációs karakterláncot használunk, amikor le akarjuk írni a funkcióinkat, hogy szükség esetén megkaphassuk a dokumentációt. Egyes IDE-k úgy nyújtanak dokumentációt, hogy egyszerűen a név fölé viszik az egérmutatót, mások pedig kiemelnek bizonyos kulcsszavakat. De a tény az, hogy a NumPy dokumentumkarakterláncai sokkal rugalmasabbak, mint más nyelveken. A docstring egy karakterlánc-literál, amely a függvénydefiníció elején fordul elő. A docstringek használatakor konkrét értékeket kell megadnunk függvények, osztályok stb. esetén.
Ha docstringeket használunk függvényekkel, akkor át kell adnunk az argumentumokat. Ha osztályokkal használjuk őket, átadjuk az attribútumokat és metódusokat. A Modulok esetében meg kell adnunk egy listát az osztályokról és a függvényekről. A csomag esetében a funkcionalitással rendelkező modulok listáját adjuk át. Tehát alapvetően a docstring célja, ahogy a neve is mutatja, hogy segítse a kódunk dokumentálását. Dokumentációt készítünk, hogy ha valaki a jövőben használja a kódunkat, akkor a docstring segítségével megértse a kódunkat és a kódunk mögött meghúzódó logikát. A beépített függvényekben is vannak docstringek; a help() függvény segítségével megnézhetjük a beépített függvények docstringjét.
Van néhány különbség a megjegyzések és a dokumentumok között. A tolmácsok figyelmen kívül hagyják a megjegyzéseket, de a docstringeket nem hagyják figyelmen kívül az értelmezők. Memória van lefoglalva a docstringekhez. A megjegyzés a kód leírása, másrészt a docstringek megmondják a kód célját.
Szintaxis:
A docstringek NumPy-ba írásának szintaxisa a következő:
'''Dokumentumlánc üzenet'''
Vagy
'''Docstring üzenet'''
Kérjük, vegye figyelembe, hogy a docstring nem függvény vagy metódus, ezért nem rendelkezik megfelelő szintaxissal. Itt csak annyit kell megjegyezni, hogy a docstringet három szimpla vagy három kettős idézőjellel kezdjük. Megírjuk a kód leírását, és ismét három szimpla vagy három dupla idézőjellel fejezzük be. A docstringekhez nincs kötelező dolog írni. Csak három szimpla vagy dupla idézőjelet kell tennie a karakterlánc leírása elé és után.
1. példa:
A doksztringek jobb megértéséhez mutassunk be egy példát. Ebben a példában a NumPy könyvtár felvétele után egyszerűen deklaráljuk az „a” változót és egy másik „b” változót. Ezt követően létrehozzuk a docstring-ünket, amely így szól: „Adjunk hozzá „a” és „b” változókat”. A mi esetünkben ez egy egyszerű példa, de ha a kódunk összetett, akkor ez sokat segít a kódolónak a kód megértésében. Ezután összegezzük az „a” és „b” változókat, és a kimeneti eredményüket egy másik „c” változóban tároljuk. Végül kiírjuk a „c” változó értékét. Most végrehajtjuk a kódunkat.
import zsibbadt mint például.a = 1
b = két
'''Adjunk hozzá a és b változókat'''
c = a+b
nyomtatás ( c )
Ez a mi kimenetünk az adott kódrészletből. Láthatjuk, hogy a rendszer nem adott hibát hibás szintaxisról vagy bármiről a kódunk 7. sorában. Ezenkívül a rendszer nem nyomtatta ki a dokumentációnkat. Ehelyett csak a „c” változónk kimenetét nyomtatta ki, amelyben azt mondtuk a rendszerünknek, hogy nyomtasson. Ez megmutatja, hogyan működnek a doksztringek. Legközelebb, amikor egy új kódoló megpróbál dolgozni a kódunkon, a docstring segítségével megérti, mit csinálunk. De ez nem kerül kinyomtatásra kimenetként, így a kód felhasználóját nem zavarja.
2. példa:
Most egy összetett példát mutatunk be, hogy megértsük a doksztring működését. Először is beépítjük a NumPy könyvtárat, majd írunk egy doc stringet, amelyben elmagyarázzuk a következő kódsort, ahol elmagyarázzuk a tömb inicializálását. A docstringeket is hozzáadjuk a kód másik részéhez. Most, ha megosztjuk ezt a kódot bármely új Python fejlesztővel anélkül, hogy hozzáadnánk a docstringeket, valahogy nehéz lesz megismernie a kód működését és célját. Először meg kell keresnie az általunk használt függvényeket. De ha hozzáadunk egy docstringet a kódunkhoz, akkor a többi fejlesztő könnyen megértheti a kódot anélkül, hogy többet tanulna a funkciókról. Nem korlátozzuk a megjegyzések hozzáadását bizonyos korlátokhoz; a megjegyzések egy vagy több sorból állhatnak. Többször is hozzáadható egy kódhoz. Ezután importálja a NumPy-t np-ként.
''''Annak a változónak a létrehozása, amelyhez egy 1x6 méretű tömböt adunk át'''sor = például. sor ( [ tizenegy , 22 , 33 , 44 , 55 , 66 ] )
''''a tömb hozzárendelése a tofile() függvényhez, hogy az arr nevű fájlba kerüljön'''
sor . fájlhoz ( 'arr.bin' )
'''fájl megjelenítése a fromfile funkcióval'''
nyomtatás ( például. fájlból ( 'arr.bin' , dtype = int ) )
Amint az a következő részletben látható, a docstringek nem jelennek meg a kimenetben, ami azt jelenti, hogy nincs hatással a kimenetre vagy a kód fordítására. A dokumentumkarakterláncokat a rendszer figyelmen kívül hagyja a fordítási folyamat során.
Következtetés
Ebben az útmutatóban a NumPy dokumentumkarakterláncairól tanultunk. Összehasonlítottuk a dokumentumokat a megjegyzésekkel, és elmagyaráztuk a kettő közötti különbséget. Megtanultuk a docstringek szintaxisát és azt, hogyan írjuk be a docstringeket a kódunkba. Továbbá azt is megpróbáltuk példák segítségével elmagyarázni, hogy mik a NumPy docstringjei és hogyan működnek. Végül megjegyeztük, hogy ezek elengedhetetlenek a kódolók számára. Nem ismételjük meg a docstringek fontosságát a NumPy-ben. Csak azt mondjuk, hogy a kódban szereplő docstringeket kell használnia. A NumPy-ban a docstringek írási stílusa a legnépszerűbb. A programozói közösségben széles körben használják, hogy megismerjék egymást a kódjaik működésével és funkcionalitásával. Ez az útmutató segít a NumPy docstringek használatának megkezdésében. Megpróbáltuk lefedni a legtöbb szükséges dolgot a NumPy docstringjei segítségével.