DocStringsDocStrings — важный инструмент для объяснения и документирования программ, помогающий сделать документацию к вашей программе проще и понятнее.
Мы можем использовать пару тройных одинарных кавычек в первой строке тела функции'''или пару тройных двойных кавычек"""чтобы определить docstring.
Вы можете использовать__doc__(обратите внимание на двойные подчёркивания) для доступа к атрибуту docstring функции.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def function():
''' скажите что-нибудь здесь！
'''
pass
print (function.__doc__) # Вызов doc
Вывод:
say something here！
DocStringsСоглашение о docstring: первая строка кратко описывает назначение функции, вторая строка пустая, а третья строка содержит подробное описание.
#!/usr/bin/python
# -*- coding: UTF-8 -*-
def printMax(x,y):
'''Выводит максимум из двух чисел.
Оба значения должны быть целыми числами.'''
x=int(x)
y=int(y)
if x>y:
print(x,'Maximum')
else:
print(y,'Maximum')
printMax(3,5)
print (printMax.__doc__) # Вызов doc
Вывод:
5 最大
打印两个数中的最大值。
两个值必须都是在整形数。