Uddrag af funktionsdokumentation i Python

I funktionens krop kan du skrive en streng, der beskriver essensen af det udførte arbejde. Sådan en streng betragtes normalt som dokumentation for funktionen. Den er indesluttet i enkelte anførselstegn og placeres på den første linje i funktionens krop. For at læse den skal du bruge en speciel funktion help, hvor parametren er funktionens navn.

Lad os sige, at vi har en funktion, der summerer to tal. En streng med tilsvarende information er efterladt:

def getSum(num1, num2):
	'this function sums two numbers'
	return num1 + num2

Lad os kalde help og finde ud af, hvad der er kommenteret i getSum:

help(getSum)

Efter koden er udført, vil en streng med funktionens navn og dens dokumentation vises i konsollen:

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

Med funktionen help kan du læse dokumentation for standardfunktioner. Lad os finde information om funktionen print:

help(print)

For kun at udskrive strengen med dokumentation fra funktionen, skal du videregive til help efter funktionens navn den servicemæssige konstruktion .__doc__:

help(print.__doc__)

Opret en funktion, der tager en liste over månedsnavne som parameter og udskriver dem med stort begyndelsesbogstav. Beskriv essensen af funktionens arbejde i dokumentationen og udskriv den i konsollen.

Udskriv al dokumentation om funktionen sum.

Udskriv kun strengen med dokumentation om funktionen len.