Вывад дакументацыі функцыі ў Python

У целе функцыі можна пропісаць радок, які апісвае суть праводжанай работы. Такую радок прынята лічыць дакументацыяй функцыі. Яна змяшчаецца ў адзінарныя двукоссі і размяшчаецца ў першай радку целе функцыі. Каб яе прачытаць, трэба выкарыстоўваць спецыяльную функцыю help, у параметр якой перадаецца імя функцыі.

Хай у нас ёсць функцыя, якая сумуе два лікі. Пра гэта пакінута радок з адпаведнай інфармацыяй:

pythondef getSum(num1, num2):
  'this function sums two numbers'
  return num1 + num2

Давайце выклічам help і даведаемся, што закаментавана ў getSum:

pythonhelp(getSum)

Пасля выканання кода ў кансолі з'явіцца радок з назвай функцыі і яе дакументацыяй:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

З дапамогай функцыі help можна чытаць дакументацыю і стандартных функцый. Давайце даведаемся інфармацыю пра функцыю print:

pythonhelp(print)

Для таго, каб вывесці толькі радок з дакументацыяй з функцыі, трэба перадаць у help пасля імя функцыі службовую канструкцыю .__doc__:

pythonhelp(print.__doc__)