Вывад дакументацыі функцыі ў Python
У целе функцыі можна пропісаць радок,
які апісвае суть праводжанай работы. Такую
радок прынята лічыць дакументацыяй
функцыі. Яна змяшчаецца ў адзінарныя двукоссі
і размяшчаецца ў першай радку целе функцыі.
Каб яе прачытаць, трэба выкарыстоўваць
спецыяльную функцыю help
, у параметр
якой перадаецца імя функцыі.
Хай у нас ёсць функцыя, якая сумуе два лікі. Пра гэта пакінута радок з адпаведнай інфармацыяй:
def getSum(num1, num2):
'this function sums two numbers'
return num1 + num2
Давайце выклічам help
і даведаемся, што
закаментавана ў getSum
:
help(getSum)
Пасля выканання кода ў кансолі з'явіцца радок з назвай функцыі і яе дакументацыяй:
Help on function getSum in module __main__:
getSum(num1, num2)
this function sums two numbers
З дапамогай функцыі help
можна чытаць
дакументацыю і стандартных функцый. Давайце
даведаемся інфармацыю пра функцыю print
:
help(print)
Для таго, каб вывесці толькі радок з
дакументацыяй з функцыі, трэба перадаць
у help
пасля імя функцыі службовую
канструкцыю .__doc__
:
help(print.__doc__)
Стварыце функцыю, якая будзе прымаць параметрам спіс назваў месяцаў і выводзіць іх з загалоўнай літары. Апішыце суць работы функцыі ў дакументацыі і вывядзіце яе ў кансоль.
Вывядзіце ўсю дакументацыю пра функцыю sum
.
Вывядзіце толькі радок з дакументацыяй пра
функцыю len
.