Krajta

Python docstring

Python docstring
Dokumentace je nezbytná pro jakékoli programování, aby snadno pochopil kód. Používá se k vysvětlení účelu použití jakéhokoli příkazu nebo funkce nebo třídy nebo modulu v programu. Pomáhá hlavnímu kodéru po dlouhé době zapamatovat si funkci libovolného kódu a také pomáhá dalším kodérům, kteří chtějí pracovat na stejném projektu. Kodér pomocí jediného řádku komentáře krátce vysvětlí konkrétní část funkce kódu. Řetězec dokumentu nebo docstring v Pythonu se používá k podrobnému vysvětlení funkce konkrétního segmentu kódu. Řádek dokumentu by měl začínat velkým písmenem a končit tečkou. První řádek dokumentu obsahuje krátký popis dokumentace obecně. Druhý řádek docstringu by měl být pro velký víceřádkový dokumentový řetězec prázdný. Trojité jednoduché uvozovky ('”) nebo trojité uvozovky („“ “) se používají k definování dokumentu v Pythonu. K obsahu dokumentu můžete přistupovat pomocí __doc__ atribut objektu a pomocí Pomoc() metoda. Způsob deklarování a přístupu k dokumentovému řetězci v Pythonu se ukázal v tomto kurzu.

Příklad 1: Přístup k dokumentovému řetězci funkce pomocí __doc__ atribut

Způsob deklarace a přístupu k dokumentu vlastní funkce se ukázal v následujícím skriptu. Následující skript vypočítá xn kde x a n budou převzaty z uživatele. Napájení () funkce má ve skriptu definovanou úlohu. Zde byl pro tuto funkci definován dokumentový řetězec. __doc__ ve skriptu byl použit atribut k tisku dokumentu s výstupem.

def power (x, n):
"Vypočítejte x na mocninu n
Přečtěte hodnoty x a n z argumentů funkce
a Vypočítat a vrátit hodnotu x na mocninu n."
návrat x ** n
# Vezměte hodnotu x
x = int (vstup ('Zadejte hodnotu x:'))
# Vezměte hodnotu n
n = int (vstup ('Zadejte hodnotu n:'))
# Vytiskněte návratovou hodnotu funkce
print ("% d k výkonu% d =% d"% (x, n, výkon (x, n)))
# Vytiskněte hodnotu dokumentu
print ("Obsah dokumentu: \ n" + síla.__doc__)

Výstup:

Po provedení výše uvedeného skriptu se zobrazí následující výstup.

Příklad 2: Přístup k dokumentovému řetězci třídy a metody pomocí Pomoc() metoda

Způsob deklarace a přístupu k dokumentovému řetězci dokumentu a metodám této třídy se ukázal v následujícím skriptu. Hlavní funkcí skriptu je seřadit číselný seznam a obrátit data seznamu. Ve třídě byl deklarován číselný seznam 8 prvků a dokumentační řetězec byl definován na začátku třídy pomocí trojitých jednoduchých uvozovek. Ve třídě byla definována metoda sort_list () pro tisk seřazených dat seznamu a dokument to definoval pro tuto metodu. reverse_list () metoda je definována pro tisk obrácených dat seznamu a pro tuto metodu byl definován také dokumentový řetězec. Pomoc() metoda volala třikrát na konci skriptu, aby vytiskla dokumentaci řetězce list_operations třída, sort_list () metoda a reverse_list () metoda.

list_operations třídy:

list_operations třídy:
"
Třídění a obrácení dat seznamu
Třída obsahuje dvě metody,
metoda sort_list () seznam seřadí a vytiskne,
metoda sort_reverse () obrátí a vytiskne seznam.
"
# Definujte seznam číselných údajů
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
"
Po seřazení vytiskněte hodnoty seznamu
Funkce vezme z argumentu objekt seznamu číselných dat,
třídit hodnoty seznamu pomocí metody sort ()
a vytiskněte hodnoty seřazeného seznamu.
"
# Třídit seznam
já.listdata.sort ()
# Vytiskněte seřazený seznam pomocí smyčky
print ("Hodnoty seřazeného seznamu: \ n")
pro hodnotu v sobě.listdata:
tisk (hodnota, "", konec = ")
def reverse_list (self):
"
Po obrácení vytiskněte hodnoty seznamu
Funkce vezme z argumentu objekt seznamu číselných dat,
obrátit hodnoty seznamu pomocí metody reverse ()
a vytiskněte hodnoty obráceného seznamu.
"
# Obrátit seznam
já.listdata.zvrátit()
# Vytiskněte obrácený seznam pomocí smyčky
print ("Hodnoty seřazeného seznamu: \ n")
pro hodnotu v sobě.listdata:
tisk (hodnota, "", konec = ")
# Vytiskněte hodnotu docstring třídy
help (seznam_operací)
# Vytvořte objekt třídy
obj = list_operations ()
# Vytiskněte hodnotu dokumentu pro konkrétní metodu
pomoc (obj.sort_list)
# Voláním metody vytisknete seřazený seznam
obj.sort_list ()

Výstup:

Po provedení skriptu se zobrazí následující výstup. Celý dokumentový řetězec skriptu byl vytištěn jako první Pomoc() funkce. Dokumentace sort_list () metoda byla vytištěna pro druhou Pomoc() funkce.

Příklad 3: Přístup k dokumentovému řetězci vestavěného modulu Python

V předchozích příkladech použil docstring v uživatelem definované třídě a funkci. Každý vestavěný modul a třída Pythonu má svůj dokumentační řetězec, který vysvětluje účel použití konkrétního modulu nebo funkce. Kodér modulu nebo funkce definuje dokumentový řetězec, aby byl kód pro uživatele srozumitelný. Následující skript vytiskne předdefinovaný dokumentový řetězec modulu datetime pomocí Pomoc() funkce.

# Importovat modul datetime
import datetime
# Zobrazit dokumentaci datetime
nápověda (datum a čas)

Výstup:

Po provedení skriptu se zobrazí následující výstup. Dokumentační řetězec modulu datetime zobrazuje jeho podrobnou dokumentaci, která ostatním pomůže správně znát funkce tříd a metod definovaných v tomto modulu.

Závěr:

Správná dokumentace je nezbytná, když je jakýkoli modul nebo funkce implementována pro konkrétní účel, aby pomohl druhému kodéru použít modul ve svém kódu k provedení konkrétního úkolu. Pokud dokumentace pro modul nebo funkci není správně definována, ostatní uživatelé budou při používání čelit problémům. Každý kodér tedy musí použít dokumentový řetězec dokumentu k poskytnutí podrobných informací ostatním, aby porozuměli kódu.

Hry OpenTTD vs Simutrans
OpenTTD vs Simutrans
Vytvoření vlastní simulace dopravy může být zábavné, uvolňující a mimořádně lákavé. Proto se musíte ujistit, že vyzkoušíte co nejvíce her, abyste našl...
Hry Výukový program OpenTTD
Výukový program OpenTTD
OpenTTD je jednou z nejpopulárnějších her pro obchodní simulaci. V této hře musíte vytvořit skvělé dopravní podnikání. Začnete však na začátku kolem r...
Hry SuperTuxKart pro Linux
SuperTuxKart pro Linux
SuperTuxKart je skvělý titul navržený tak, aby vám ve vašem systému Linux přinesl zážitek Mario Kart zdarma. Je to docela náročné a zábavné hrát, je n...