Python docstring

A dokumentáció elengedhetetlen minden programozáshoz, hogy könnyen megértse a kódot. Arra szolgál, hogy elmagyarázza a program bármely utasításának, funkciójának, osztályának vagy moduljának használatának célját. Segít a fő kódolónak hosszú idő után megjegyezni bármelyik kód funkcióját, és segít más kódolóknak is, akik ugyanazon a projekten szeretnének dolgozni. A kódoló egyetlen megjegyzéssorral röviden megmagyarázza a kód funkciójának adott részét. A Python dokumentum karaktersorozat vagy a docstring a kód egy adott szegmensének funkciójának részletes magyarázatára szolgál. A parancssornak nagybetűvel kell kezdődnie, és egy ponttal kell végződnie. A docstring első sora általában a dokumentáció rövid leírását tartalmazza. A docstring második sorának üresnek kell lennie a nagy, többsoros docstringnél. Háromszoros idézőjelek ('') vagy hármas dupla idézőjelek („” ”) a docstring definiálására szolgálnak a Pythonban. A docstring tartalom a következővel érhető el a __doc__ az objektum attribútuma és a Segítség() módszer. A leírás és a docstring Python-ban történő elérésének módja bemutatásra került ebben az oktatóanyagban.

1. példa: A függvény docstringjének elérése a __doc__ tulajdonság

Az egyéni függvény docstringjének deklarálásának és elérésének módját a következő szkript mutatja be. A következő szkript kiszámítja az x értéketⁿ ahol x és n kerül a felhasználótól. Erő () függvény a szkriptben meghatározta a feladat elvégzését. Itt definiálta a docstringet ehhez a függvényhez. __doc__ attribútumot használták a szkriptben a docstring kinyomtatásához.

def teljesítmény (x, n):
"Számítsa ki x-et az n hatványra
Olvassa le x és n értékét a függvény argumentumából
és Számítsa ki, és adja vissza az x értéket az n hatványra."
visszatérés ** ** n
# Vegyük x értékét
x = int (input ('Írja be az x értékét:'))
# Vegyük az n értékét
n = int (input ('Írja be n értékét:'))
# Nyomtassa ki a művelet visszatérési értékét
nyomtatás ("A% d a teljesítmény% d =% d"% (x, n, teljesítmény (x, n)))
# Nyomtassa ki a docstring értéket
print ("A docstring tartalma: \ n" + power.__doc__)

Kimenet:

A fenti kimenet a fenti parancsfájl végrehajtása után jelenik meg.

2. példa: Az osztály és metódus docstringjének elérése Segítség() módszer

A dokumentum sztringjének deklarálásának és elérésének módját, valamint az adott osztály módszereit a következő szkript mutatja be. A szkript fő funkciója egy numerikus lista rendezése és a lista adatainak megfordítása. A 8 elemből álló numerikus listát deklaráltuk az osztályban, és a docstringet az osztály elején definiáltuk három egyszeres idézőjel használatával. A sort_list () metódust definiálták az osztályban a lista rendezett adatainak kinyomtatására, és a dokumentum ezt definiálta erre a módszerre. fordított_lista () metódus van megadva a lista megfordított adatainak kinyomtatásához, és ehhez a metódushoz a docstring is meg van határozva. Segítség() metódus háromszor hívta meg a szkript végén, hogy kinyomtassa a list_operations osztály, sort_list () módszer, és a fordított_lista () módszer.

osztálylista_műveletek:

osztálylista_műveletek:
"
A lista adatainak rendezése és visszafordítása
Az osztály két módszert tartalmaz,
A sort_list () metódus rendezi és kinyomtatja a listát,
A sort_reverse () metódus megfordítja és kinyomtatja a listát.
"
# Definiálja a numerikus adatok listáját
listadata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
"
Rendezés után nyomtassa ki a listaértékeket
A függvény numerikus adatok listás objektumát veszi fel az argumentumból,
rendezze a listaértékeket a sort () módszerrel
és kinyomtatja a rendezett lista értékeit.
"
# Rendezze a listát
maga.listadata.fajta()
# Nyomtassa ki a rendezett listát a hurok segítségével
print ("A rendezett lista értékei: \ n")
az érték önmagában.listdata:
nyomtatás (érték, "", vég = ")
def fordított_lista (saját):
"
Nyomja meg a lista értékeit a megfordítás után
A függvény numerikus adatok listás objektumát veszi fel az argumentumból,
fordítsa meg a listaértékeket fordított () módszerrel
és kinyomtatja a megfordított lista értékeit.
"
# Fordítsa meg a listát
maga.listadata.fordított()
# Nyomtassa ki a fordított listát a hurok segítségével
print ("A rendezett lista értékei: \ n")
az érték önmagában.listdata:
nyomtatás (érték, "", vég = ")
# Nyomtassa ki az osztály docstring értékét
súgó (list_operations)
# Létrehozása az osztály objektumának
obj = list_operations ()
# Nyomtassa ki az adott módszer docstring értékét
segítség (objekt.sort_list)
# Hívja meg a módszert a rendezett lista kinyomtatásához
obj.sort_list ()

Kimenet:

A szkript végrehajtása után a következő kimenet jelenik meg. A szkript összes docstringje először kinyomtatásra került Segítség() funkció. A tanítás sort_list () módszert nyomtattuk a másodikra Segítség() funkció.

3. példa: A beépített Python modul docstringjének elérése

Az előző példákban a docstringet a felhasználó által definiált osztályban és függvényben használták. Minden beépített Python modulnak és osztálynak megvan a docstringje, amely elmagyarázza az adott modul vagy függvény használatának célját. A modul vagy függvény kódolója meghatározza a docstringet, hogy érthetővé tegye a kódot a felhasználók számára. A következő szkript kinyomtatja a dátumidő modul előre definiált utasításait a Segítség() funkció.

# Dátumidő modul importálása
importálás ideje
# Megjeleníti a dátum időkódját
segítség (dátumidő)

Kimenet:

A szkript végrehajtása után a következő kimenet jelenik meg. A datetime modul utasításai megmutatják annak részletes dokumentációját, hogy segítsen másokat a modulban definiált osztályok és módszerek funkcióinak megfelelő megismerésében.

Következtetés:

A megfelelő dokumentáció elengedhetetlen, ha bármely modult vagy funkciót egy adott célra valósítanak meg, hogy segítsen a másik kódolónak a modulban a kódjában használni az adott feladatot. Ha a modul vagy a funkció dokumentációja nincs megfelelően meghatározva, akkor a többi felhasználónak problémák merülnek fel a használat során. Tehát minden kódolónak használnia kell a dokumentum docstringjét, hogy részletes információkat nyújtson a többiek számára a kód megértéséhez.