Funkcijos dokumentacijos išvedimas Python

Funkcijos kūne galima parašyti eilutę, apibūdinančią atliekamo darbo esmę. Tokia eilutė paprastai laikoma funkcijos dokumentacija. Ji yra rašoma viengubose kabutėse ir patalpinta pirmoje funkcijos kūno eilutėje. Norint ją perskaityti, reikia naudoti specialią funkciją help, kurios parametrui perduodamas funkcijos pavadinimas.

Tarkime, turime funkciją, kuri sudeda du skaičius. Apie tai palikta eilutė su atitinkama informacija:

def getSum(num1, num2):
	'si funkcija sudeda du skaičius'
	return num1 + num2

Paleiskime help ir sužinokime, kas užkomentuota getSum funkcijoje:

help(getSum)

Vykdant kodą, konsolėje pasirodys eilutė su funkcijos pavadinimu ir jos dokumentacija:

Help on function getSum in module __main__:

getSum(num1, num2)
	si funkcija sudeda du skaičius

Naudojant funkciją help galima skaityti ir standartinių funkcijų dokumentaciją. Sužinokime informaciją apie funkciją print:

help(print)

Norint išvesti tik dokumentacijos eilutę iš funkcijos, reikia perduoti į help po funkcijos pavadinimo specialų konstruktą .__doc__:

help(print.__doc__)

Sukurkite funkciją, kuri priims parametrą kaip mėnesių pavadinimų sąrašą ir juos išves didžiąja raide. Apibūdinkite funkcijos veikimo esmę dokumentacijoje ir išveskite ją į konsolę.

Išveskite visą dokumentaciją apie funkciją sum.

Išveskite tik dokumentacijos eilutę apie funkciją len.