Výpis dokumentace funkce v Pythonu

V těle funkce lze zapsat řetězec, popisující podstatu prováděné práce. Takový řetězec je obvykle považován za dokumentaci funkce. Je uzavřen do jednoduchých uvozovek a umístěn na prvním řádku těla funkce. Pro její přečtení je třeba použít speciální funkci help, do jejíhož parametru se předá jméno funkce.

Předpokládejme, že máme funkci, která sčítá dvě čísla. O tom je ponechán řetězec s příslušnou informací:

def getSum(num1, num2):
	'tato funkce sčítá dvě čísla'
	return num1 + num2

Zavolejme help a zjistěme, co je zakomentováno v getSum:

help(getSum)

Po provedení kódu se v konzoli objeví řádek s názvem funkce a její dokumentací:

Help on function getSum in module __main__:

getSum(num1, num2)
	tato funkce sčítá dvě čísla

Pomocí funkce help lze číst dokumentaci i standardních funkcí. Zjistěme informace o funkci print:

help(print)

Pro vypsání pouze řetězce s dokumentací z funkce je třeba předat do help za jménem funkce servisní konstrukci .__doc__:

help(print.__doc__)

Vytvořte funkci, která bude přijímat parametrem seznam názvů měsíců a vypisovat je s velkým počátečním písmenem. Popište podstatu práce funkce v dokumentaci a vypište ji do konzole.

Vypište veškerou dokumentaci o funkci sum.

Vypište pouze řetězec s dokumentací o funkci len.