ფუნქციის დოკუმენტაციის ჩვენება 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 ფუნქციის შესახებ.