Funktsiooni dokumentatsiooni kuvamine Pythonis

Funktsiooni kehas saab kirjutada stringi, kirjeldamaks tehtava töö olemust. Sellist stringi peetakse tavaliselt funktsiooni dokumentatsiooniks. See paigutatakse ühekordsete jutumärkide sisse ja asub funktsiooni keha esimesel real. Selle lugemiseks tuleb kasutada spetsiaalset funktsiooni help, mille parameetrisse antakse funktsiooni nimi.

Olgu meil funktsioon, mis liidab kaks numbrit. Sellest on jäetud string vastava teabega:

pythondef getSum(num1, num2):
  'see funktsioon liidab kaks numbrit'
  return num1 + num2

Väljutame help ja uurime, mis on kommenteeritud funktsioonis getSum:

pythonhelp(getSum)

Pärast koodi käivitamist kuvatakse konsoolis funktsiooni nimi ja selle dokumentatsioon:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  see funktsioon liidab kaks numbrit

Funktsiooni help abil saab lugeda ka standardfunktsioonide dokumentatsiooni. Uurime funktsiooni print kohta käivat teavet:

pythonhelp(print)

Et väljutada ainult funktsiooni dokumentatsioonistring, tuleb help-ile edastada pärast funktsiooni nimet teeninduskonstruktsioon .__doc__:

pythonhelp(print.__doc__)