Zobrazenie dokumentácie funkcie v Pythone

V tele funkcie je možné uviesť reťazec, ktorý popisuje podstatu jej činnosti. Takýto reťazec sa zvyčajne považuje za dokumentáciu funkcie. Je uzavretý v jednoduchých úvodzovkách a umiestnený v prvom riadku tela funkcie. Na jej prečítanie je potrebné použiť špeciálnu funkciu help, do parametra ktorej sa odovzdáva názov funkcie.

Predpokladajme, že máme funkciu, ktorá sčíta dve čísla. Táto informácia je uvedená v reťazci s príslušnou dokumentáciou:

pythondef getSum(num1, num2):
  'táto funkcia sčíta dve čísla'
  return num1 + num2

Zavolajme help a zistime, čo je zakomentované v getSum:

pythonhelp(getSum)

Po vykonaní kódu sa v konzole objaví reťazec s názvom funkcie a jej dokumentáciou:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  táto funkcia sčíta dve čísla

Pomocou funkcie help je možné čítať dokumentáciu aj štandardných funkcií. Zistime informácie o funkcii print:

pythonhelp(print)

Ak chcete zobraziť iba reťazec s dokumentáciou funkcie, je potrebné odovzdať do help za názvom funkcie servisnú konštrukciu .__doc__:

pythonhelp(print.__doc__)