Výpis dokumentace funkce v Pythonu

V těle funkce lze zapsat řetězec, popisující podstatu prováděné práce. Takový řetězec je obvykle považován za dokumentaci funkce. Je uzavřen do jednoduchých uvozovek a umístěn na prvním řádku těla funkce. Pro její přečtení je třeba použít speciální funkci help, do jejíhož parametru se předá jméno funkce.

Předpokládejme, že máme funkci, která sčítá dvě čísla. O tom je ponechán řetězec s příslušnou informací:

pythondef getSum(num1, num2):
  'tato funkce sčítá dvě čísla'
  return num1 + num2

Zavolejme help a zjistěme, co je zakomentováno v getSum:

pythonhelp(getSum)

Po provedení kódu se v konzoli objeví řádek s názvem funkce a její dokumentací:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  tato funkce sčítá dvě čísla

Pomocí funkce help lze číst dokumentaci i standardních funkcí. Zjistěme informace o funkci print:

pythonhelp(print)

Pro vypsání pouze řetězce s dokumentací z funkce je třeba předat do help za jménem funkce servisní konstrukci .__doc__:

pythonhelp(print.__doc__)