Visar funktionsdokumentation i Python

I funktionskroppen kan man skriva en sträng som beskriver kärnan i det utförda arbetet. En sådan sträng anses vanligtvis vara dokumentation för funktionen. Den omges av enkla citattecken och placeras på första raden i funktionskroppen. För att läsa den måste man använda en speciell funktion help, till vars parameter man skickar funktionens namn.

Låt oss säga att vi har en funktion som summerar två nummer. En sträng med motsvarande information har lämnats om detta:

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

Låt oss anropa help och ta reda på vad som har kommenterats i getSum:

help(getSum)

Efter att koden har körts kommer en sträng med funktionens namn och dess dokumentation att visas i konsolen:

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

Med hjälp av funktionen help kan man läsa dokumentationen även för standardfunktioner. Låt oss ta reda på information om funktionen print:

help(print)

För att endast visa strängen med dokumentation från funktionen måste man skicka till help efter funktionens namn den speciella konstruktionen .__doc__:

help(print.__doc__)

Skapa en funktion som tar en lista med månaders namn som parameter och visar dem med stor begynnelsebokstav. Beskriv funktionens kärna i dokumentationen och visa den i konsolen.

Visa all dokumentation om funktionen sum.

Visa endast strängen med dokumentation om funktionen len.