Függvény dokumentációjának megjelenítése Pythonban

A függvény törzsében megadhatunk egy stringet, ami leírja a függvény működését. Egy ilyen stringet általában a függvény dokumentációjának nevezünk. A stringet szimpla idézőjelek közé zárjuk és a függvény törzsének első sorába helyezzük el. Ahhoz, hogy elolvashassuk, a speciális help függvényt kell használnunk, melynek paramétereként a függvény nevét adjuk meg.

Tegyük fel, van egy függvényünk, amely összead két számot. Erről egy megfelelő információs string van elhelyezve:

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

Hívjuk meg a help függvényt, és derítsük ki, mi van dokumentálva a getSum függvényben:

pythonhelp(getSum)

A kód végrehajtása után a konzolon megjelenik egy sor a függvény nevével és annak dokumentációjával:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  this function sums two numbers

A help függvényt standard függvények dokumentációjának olvasására is használhatjuk. Derítsük ki a print függvény információit:

pythonhelp(print)

Ahhoz, hogy csak a dokumentációs stringet jelenítsük meg a függvényből, a help függvénynek a függvény neve után meg kell adni a .__doc__ szolgáltatási konstrukciót:

pythonhelp(print.__doc__)