Prikaz dokumentacije funkcije u Python-u

U telu funkcije možemo napisati string koji opisuje suštinu izvršavanja. Takav string se smatra dokumentacijom funkcije. On se stavlja u jednostruke navodnike i postavlja se u prvi red tela funkcije. Da bismo je pročitali, potrebno je da koristimo posebnu funkciju help, kojoj se kao parametar prosledi ime funkcije.

Neka imamo funkciju koja sabira dva broja. O tome je ostavljen string sa odgovarajućom informacijom:

pythondef getSum(num1, num2):
  'ova funkcija sabira dva broja'
  return num1 + num2

Hajde da pozovemo help i saznamo šta je zabeleženo u getSum:

pythonhelp(getSum)

Nakon izvršavanja koda u konzoli će se pojaviti string sa nazivom funkcije i njenom dokumentacijom:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  ova funkcija sabira dva broja

Pomoću funkcije help možemo čitati dokumentaciju i standardnih funkcija. Hajde da saznamo informacije o funkciji print:

pythonhelp(print)

Kako bismo ispisali samo string sa dokumentacijom funkcije, potrebno je proslediti u help posle imena funkcije servisnu konstrukciju .__doc__:

pythonhelp(print.__doc__)