Python да функцияси ҳужжатлашини чиқариш

Функция танасида бажарилаётган ишнинг моҳиятини тасвирловчи сатрни ёзиш мумкин. Бундай сатр функциянинг ҳужжатлаши деб ҳисобланади. У ягоқ қошиқларга олиниб, функция танасининг биринчи сатрида жойлашади. Уни ўқиш учун maxsus help функциясидан фойдаланиш керак, унинг параметрига функция номи берилади.

Фарз қилайлик, бизда икки сонни йиғиндисини ҳисобловчи функция бор. Бу ҳақда мос маълумот билан сатр қолдирилган:

def getSum(num1, num2):
	'бу функция икки сонни йиғади'
	return num1 + num2

Келинг help ни чақириб, getSum да нима изоҳланганини билайлик:

help(getSum)

Код бажарилганидан сўнг консолда функция номи ва унинг ҳужжатлаши билан сатр пайдо бўлади:

Help on function getSum in module __main__:

getSum(num1, num2)
	бу функция икки сонни йиғади

help функцияси ёрдамида standart функцияларнинг ҳужжатлашини ҳам ўқиш мумкин. Келинг print функцияси ҳақида маълумот оламиз:

help(print)

Функциядан фақат ҳужжатлаш сатрини чиқариш учун help га функция номидан кейин .__doc__ xizmat кўрсатувчи контрукциясини бериш керак:

help(print.__doc__)

Параметр сифатида ойлар номлари рўйхатини қабул қиладиган ва уларни бош ҳарф билан чиқарадиган функция яратинг. Функция ишининг моҳиятини ҳужжатлашда тасвирланг ва уни консолда чиқаринг.

sum функцияси ҳақида барча ҳужжатлашни чиқаринг.

len функцияси ҳақида фақат ҳужжатлаш сатрини чиқаринг.