Python Docstring

Dokumentacja jest niezbędna do łatwego zrozumienia kodu kodu. Służy do wyjaśnienia celu użycia dowolnej instrukcji, funkcji, klasy lub modułu w programie. Pomaga głównym koderowi pamiętać funkcję dowolnego kodu po długim czasie, a także pomaga innym koderom, którzy chcą pracować nad tym samym projektem. Koder używa pojedynczego wiersza komentarza do wyjaśnienia konkretnej części funkcji kodu. Python Dokument String lub Docstring służy szczegółowo funkcji określonego segmentu kodu. Linia DocString powinna rozpocząć się od litery i zakończyć okresem. Pierwszy wiersz Docstring ogólnie zawiera krótki opis dokumentacji. Drugi wiersz DocString powinien być pusty dla dużego wielopoziomowego dokumentu. Triple Single Quotes ('”) Lub Potrójne podwójne cytaty („” ”) są używane do zdefiniowania dokumentu w Python. Dostęp do treści DocString za pomocą za pomocą __doc__ atrybut obiektu i za pomocą pomoc() metoda. Sposób deklarowania i dostępu do Docstring w Pythonie pokazano w tym samouczku.

Przykład-1: Dostęp do dokumentacji funkcji za pomocą __doc__ atrybut

Sposób deklarowania i dostępu do doktora funkcji niestandardowej pokazano w następującym skrypcie. Poniższy skrypt oblicza x^N gdzie x i n zostaną pobrane od użytkownika. Moc () Funkcja zdefiniowała w skrypcie, aby wykonać zadanie. Tutaj DocString został zdefiniowany dla tej funkcji. __doc__ Atrybut został użyty w skrypcie do wydrukowania dokumentu z wyjściem.

def Power (x, n):
„Oblicz x do mocy n
Przeczytaj wartości x i n z argumentów funkcji
i oblicz i zwróć wartość x do mocy n."
powrót x ** n
# Weź wartość x
x = int (input ('Wprowadź wartość x:'))
# Weź wartość n
n = int (input ('Wprowadź wartość n:'))
# Wydrukuj wartość zwracania funkcji
Drukuj („ %d do mocy %d = %d” %(x, n, moc (x, n))))
# Wydrukuj wartość DocString
Drukuj („Treść DocString: \ n” +.__doc__)

Wyjście:

Po wykonaniu powyższego skryptu pojawi się następujące dane wyjściowe.

Przykład-2: Dostęp do dokumentacji klas i metody za pomocą pomoc() metoda

Sposób deklarowania i dostępu do dokumentu dokumentu oraz metody tej klasy pokazano w następującym skrypcie. Główną funkcją skryptu jest uporządkowanie listy numerycznej i odwrócenie danych z listy. W klasie zadeklarowano listę numeryczną 8 elementów, a DocString został zdefiniowany na początku klasy za pomocą potrójnych pojedynczych cytatów. Metoda sort_list () została zdefiniowana w klasie, aby wydrukować posortowane dane z listy, a dokument to zdefiniował dla tej metody. reverse_list () Metoda jest zdefiniowana w celu wydrukowania odwróconych danych listy, a DocString został również zdefiniowany dla tej metody. pomoc() Metoda wywołała trzykrotnie na końcu skryptu, aby wydrukować dokument List_operations klasa, sort_list () metoda i reverse_list () metoda.

Klasy List_operations:

Klasy List_operations:
"
Sortowanie i cofanie danych listy
Klasa zawiera dwie metody,
Metoda sort_list () sortuje i wydrukuje listę,
Metoda sort_reverse () odwróci i wydrukuje listę.
"
# Zdefiniuj listę danych numerycznych
Listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
"
Wydrukuj wartości listy po sortowaniu
Funkcja obejmie obiekt listy danych numerycznych z argumentu,
Sortuj wartości listy za pomocą metody sort ()
i wydrukuj wartości posortowanej listy.
"
# Sortuj listę
samego siebie.ListData.sortować()
# Wydrukuj posortowaną listę za pomocą pętli
Drukuj („Wartości posortowanej listy: \ n”)
Dla wartości w sobie.ListData:
print (wartość, „”, end = ”)
def reverse_list (self):
"
Wydrukuj wartości listy po odwróceniu
Funkcja obejmie obiekt listy danych numerycznych z argumentu,
Odwróć wartości listy za pomocą metody odwrotnej ()
i wydrukuj wartości odwróconej listy.
"
# Odwróć listę
samego siebie.ListData.odwracać()
# Wydrukuj odwróconą listę za pomocą pętli
Drukuj („Wartości posortowanej listy: \ n”)
Dla wartości w sobie.ListData:
print (wartość, „”, end = ”)
# Wydrukuj wartość DocString w klasie
Pomoc (List_operations)
# Utwórz obiekt klasy
obj = list_operations ()
# Wydrukuj wartość DocString konkretnej metody
Pomoc (OBJ.sort_list)
# Wywołaj metodę, aby wydrukować posortowaną listę
obj.sort_list ()

Wyjście:

Następujące dane wyjściowe pojawi się po wykonaniu skryptu. Cały doktring skryptu został wydrukowany dla pierwszego pomoc() funkcjonować. Docstring sort_list () Metoda została wydrukowana na sekundę pomoc() funkcjonować.

Przykład-3: Dostęp do dokumentu wbudowanego modułu Pythona

W poprzednich przykładach DocString wykorzystał w klasie i funkcji zdefiniowanej przez użytkownika. Każdy wbudowany moduł i klasa Python ma swój dokument, który wyjaśnia cel użycia tego konkretnego modułu lub funkcji. Koder modułu lub funkcji określa dokument, aby kod był zrozumiały dla użytkowników. Poniższy skrypt wydrukuje wstępnie zdefiniowane dokumenty modułu DateTime za pomocą pomoc() funkcjonować.

# Importuj moduł DATETIME
Importuj datetime
# Wyświetl DOCSTRING DATETIME
Pomoc (datetime)

Wyjście:

Po wykonaniu skryptu pojawi się następujące dane wyjściowe. Docstring modułu DateTime pokazuje szczegółową dokumentację, aby pomóc innym w znacznym znaczeniu funkcji klas i metod zdefiniowanych w tym module.

Wniosek:

Właściwa dokumentacja jest niezbędna, gdy dowolny moduł lub funkcja jest wdrażana w określonym celu, aby pomóc drugiemu koderowi w użyciu modułu w ich kodzie do wykonania konkretnego zadania. Jeśli dokumentacja nie jest odpowiednio zdefiniowana dla modułu lub funkcji, inni użytkownicy będą musieli stawić czoła problemom z użyciem. Tak więc każdy koder musi użyć dokumentu dokumentu, aby podać szczegółowe informacje dla innych, aby zrozumieć kod.