Вывод документации функции в 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__)