Phenquestions
Пример-1: Достъп до docstring на функция, използваща __doc__ атрибут
Начинът на деклариране и достъп до документацията на персонализирана функция е показан в следващия скрипт. Следният скрипт изчислява xн където x и n ще бъдат взети от потребителя. Мощност () функция е определила в скрипта да изпълни задачата. Тук документната лента е дефинирана за тази функция. __doc__ attribute е използван в скрипта за отпечатване на документа с изхода.
def мощност (x, n):Msgstr "Изчислете x до степен n
Прочетете стойностите на x и n от аргументите на функцията
и изчислете и върнете стойността на x на степен n."
връщане x ** n
# Вземете стойността на x
x = int (вход ('Въведете стойността на x:'))
# Вземете стойността на n
n = int (вход ('Въведете стойността на n:'))
# Отпечатайте връщаната стойност на функцията
print ("% d до степен% d =% d"% (x, n, мощност (x, n))))
# Отпечатайте стойността на документа
print ("Съдържанието на документа: \ n" + мощност.__doc__)
Изход:
След изпълнението на горния скрипт ще се появи следният изход.
Пример-2: Достъп до документация на клас и метод с използване помогне() метод
Начинът на деклариране и достъп до документацията на документа и методите на този клас е показан в следващия скрипт. Основната функция на скрипта е да сортира числов списък и да обърне данните от списъка. В класа е деклариран числов списък от 8 елемента и в началото на класа е дефиниран docstring с помощта на тройни единични кавички. Методът sort_list () е дефиниран в класа за отпечатване на сортираните данни от списъка и документът е дефинирал това за този метод. reverse_list () методът е дефиниран за отпечатване на обърнатите данни на списъка и документният низ също е дефиниран за този метод. помогне() метод е извикал три пъти в края на скрипта, за да отпечата документацията на list_operations клас, sort_list () метод и reverse_list () метод.
class list_operations:
class list_operations:"
Сортиране и обръщане на данните от списъка
Класът съдържа два метода,
sort_list () методът ще сортира и отпечата списъка,
Методът sort_reverse () ще обърне и отпечата списъка.
"
# Определете списък с числови данни
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (самостоятелно):
"
Отпечатайте стойностите на списъка след сортиране
Функцията ще вземе от аргумента списъчен обект с числови данни,
сортирайте стойностите на списъка с помощта на метода sort ()
и отпечатайте стойностите на сортирания списък.
"
# Сортирайте списъка
себе си.listdata.вид()
# Отпечатайте сортирания списък с помощта на цикъл
print ("Стойностите на сортирания списък: \ n")
за стойност в себе си.listdata:
print (стойност, "", край = ")
def reverse_list (самостоятелно):
"
Отпечатайте стойностите на списъка след обръщане
Функцията ще вземе от аргумента списъчен обект с числови данни,
обърнете стойностите на списъка, като използвате метода reverse ()
и отпечатайте стойностите на обърнатия списък.
"
# Обърнете списъка
себе си.listdata.обратен()
# Отпечатайте обратния списък с помощта на цикъл
print ("Стойностите на сортирания списък: \ n")
за стойност в себе си.listdata:
print (стойност, "", край = ")
# Отпечатайте стойността на документа в класа
помощ (list_operations)
# Създайте обект от класа
obj = list_operations ()
# Отпечатайте стойността на документа в конкретния метод
помощ (obj.sort_list)
# Извикайте метода, за да отпечатате сортирания списък
обект.sort_list ()
Изход:
След изпълнението на скрипта ще се появи следният изход. Цялата документация на скрипта е отпечатана за първи път помогне() функция. Документацията на sort_list () метод е отпечатан за втория помогне() функция.
Пример-3: Достъп до документация на вградения модул Python
В предишните примери docstring е използвал в потребителски дефиниран клас и функция. Всеки вграден модул и клас Python има своя документ, който обяснява целта на използването на този конкретен модул или функция. Кодерът на модула или функцията дефинира документа, за да направи кода разбираем за потребителите. Следният скрипт ще отпечата предварително дефинирания документ на модула за дата и час, като използва помогне() функция.
# Импортиране на модул за дата и часимпортиране на дата и час
# Показване на документацията за дата и час
помощ (дата и час)
Изход:
След изпълнението на скрипта ще се появи следният изход. Документацията на модула за дата и час показва подробната документация за него, за да помогне на останалите да познаят правилно функциите на класовете и методите, дефинирани в този модул.
Заключение:
Правилната документация е от съществено значение, когато някой модул или функция е реализиран за конкретната цел, за да помогне на другия кодер да използва модула в техния код, за да изпълни конкретната задача. Ако документацията не е дефинирана правилно за модула или функцията, останалите потребители ще срещнат проблеми при използването им. Така че всеки кодер трябва да използва документацията на документа, за да предостави подробна информация, за да могат останалите да разберат кода.
