Python da funksiya hujjatlarini chiqarish

Funksiya tanasida bajarilayotgan ishning mazmunini tavsiflovchi satr yozish mumkin. Bunday satr odatda funksiyaning hujjati hisoblanadi. U bitta tirnoqqa olinadi va funksiya tanasining birinchi satrida joylashtiriladi. Uni o'qish uchun maxsus help funksiyasidan foydalanish kerak, uning parametriga funksiya nomi beriladi.

Faraz qilaylik, bizda ikkita sonni yig'indisini hisoblaydigan funksiya bor. Bu haqda mos ma'lumot bilan satr qoldirilgan:

def getSum(num1, num2):
	'bu funksiya ikkita sonni qo'shadi'
	return num1 + num2

Keling help ni chaqiraylik va getSum da nima izoh qoldirilganligini bilib olaylik:

help(getSum)

Kod bajarilgandan so'ng konsolda funksiya nomi va uning hujjati bilan satr paydo bo'ladi:

Help on function getSum in module __main__:

getSum(num1, num2)
	bu funksiya ikkita sonni qo'shadi

help funksiyasi yordamida standart funksiyalarning hujjatlarini ham o'qish mumkin. Keling print funksiyasi haqida ma'lumot bilib olaylik:

help(print)

Faqat funksiyadagi hujjatlar satrini chiqarish uchun, help ga funksiya nomidan keyin .__doc__ xizmat ko'rsatish konstruksiyasini uzatish kerak:

help(print.__doc__)

Parametr sifatida oylar nomlarining ro'yxatini qabul qiladigan va ularni bosh harf bilan chiqaradigan funksiya yarating. Funksiya ishining mazmunini hujjatda tavsiflang va uni konsolda chiqaring.

sum funksiyasi haqida butun hujjatni chiqaring.

len funksiyasi haqida faqat hujjatlar satrini chiqaring.