Извеждане на документация на функция в 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__)