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:

def 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:

help(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:

Help 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:

help(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:

help(print.__doc__)

Készítsen egy függvényt, amely a hónapok neveit tartalmazó listát veszi fel paraméterként, és nagybetűvel kezdi a neveket. Írja le a függvény működését a dokumentációban, és jelenítse meg a konzolon.

Jelenítse meg a sum függvény teljes dokumentációját.

Csak a len függvény dokumentációs stringjét jelenítse meg.