Функсияи 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 чоп кунед.