Wyświetlanie dokumentacji funkcji w Pythonie

W ciele funkcji można wpisać ciąg znaków, opisujący istotę wykonywanej pracy. Taki ciąg znaków jest uważany za dokumentację funkcji. Jest ujęty w pojedyncze cudzysłowy i umieszczony w pierwszej linii ciała funkcji. Aby go przeczytać, należy użyć specjalnej funkcji help, do parametru której przekazywana jest nazwa funkcji.

Załóżmy, że mamy funkcję sumującą dwie liczby. Zostawiono o tym ciąg znaków z odpowiednią informacją:

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

Wywołajmy help i dowiedzmy się, co zakomentowano w getSum:

pythonhelp(getSum)

Po wykonaniu kodu w konsoli pojawi się ciąg znaków z nazwą funkcji i jej dokumentacją:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

Za pomocą funkcji help można czytać dokumentację także standardowych funkcji. Dowiedzmy się informacji o funkcji print:

pythonhelp(print)

Aby wyświetlić tylko ciąg znaków z dokumentacją funkcji, należy przekazać do help po nazwie funkcji konstrukcję serwisową .__doc__:

pythonhelp(print.__doc__)