Shfaqja e dokumentacionit të funksionit në Python

Në trupin e funksionit mund të shkruhet një string, që përshkruan thelbin e punës së kryer. Një string të tillë zakonisht konsiderohet dokumentacion i funksionit. Ai mbyllet në thonjëza të vetme dhe vendoset në rreshtin e parë të trupit të funksionit. Për ta lexuar, duhet përdorur funksionin special help, në parametrin e të cilit kaldohet emri i funksionit.

Le të themi se kemi një funksion që mbledh dy numra. Për këtë është lënë një string me informacionin përkatës:

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

Le të thërrasim help dhe të zbulojmë se çfarë është komentuar në getSum:

help(getSum)

Pas ekzekutimit të kodit në konsol do të shfaqet një string me emrin e funksionit dhe dokumentacionin e tij:

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

Me ndihmën e funksionit help mund të lexohet dokumentacioni edhe i funksioneve standarde. Le të zbulojmë informacionin për funksionin print:

help(print)

Që të shfaqet vetëm stringu me dokumentacionin nga funksioni, duhet kaluar në help pas emrit të funksionit konstruksioni shërbues .__doc__:

help(print.__doc__)

Krijoni një funksion që do të marrë si parametër një listë me emra muajsh dhe t'i shfaqë ato me shkronjë të madhe. Përshkruani thelbin e punës së funksionit në dokumentacion dhe shfaqeni atë në konsol.

Shfaqni të gjithë dokumentacionin për funksionin sum.

Shfaqni vetëm stringun me dokumentacion për funksionin len.