Прикажување на документација на функција во Python

Во телото на функцијата може да се напише стринг, кој ја опишува суштината на работата што се извршува. Ваквиот стринг обично се смета за документација на функцијата. Тој се става во единечни наводници и се поставува во првиот ред од телото на функцијата. За да се прочита, потребно е да се користи специјална функција help, во чиј параметар се пренесува името на функцијата.

Да претпоставиме дека имаме функција која собира две броеви. За ова е оставен стринг со соодветна информација:

def getSum(num1, num2):
	'оваа функција собира два броја'
	return num1 + num2

Да ја повикаме help и да дознаеме што е коментирано во getSum:

help(getSum)

По извршувањето на кодот во конзолата ќе се појави стринг со името на функцијата и нејзината документација:

Help on function getSum in module __main__:

getSum(num1, num2)
	оваа функција собира два броја

Со функцијата help може да се чита документацијата и на стандардните функции. Да дознаеме информации за функцијата print:

help(print)

За да се испечати само стрингот со документација од функцијата, потребно е да се пренесе во help после името на функцијата служебната конструкција .__doc__:

help(print.__doc__)

Создајте функција која ќе прима параметар како список на имиња на месеци и ќе ги печати со голема почетна буква. Опшете ја суштината на работата на функцијата во документацијата и испечатете ја во конзола.

Испечатете ја целата документација за функцијата sum.

Испечатете само стрингот со документација за функцијата len.