Ausgabe der Funktionsdokumentation in Python

Im Körper einer Funktion kann man einen String angeben, der den Zweck der durchgeführten Arbeit beschreibt. Ein solcher String wird üblicherweise als Dokumentation der Funktion betrachtet. Er wird in einfache Anführungszeichen eingeschlossen und in der ersten Zeile des Funktionskörpers platziert. Um ihn zu lesen, muss man die spezielle Funktion help verwenden, der der Name der Funktion als Parameter übergeben wird.

Nehmen wir an, wir haben eine Funktion, die zwei Zahlen addiert. Darüber wurde eine Zeile mit entsprechender Information als Dokumentation hinterlassen:

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

Lassen Sie uns help aufrufen und herausfinden, was in getSum dokumentiert ist:

help(getSum)

Nach der Ausführung des Codes erscheint in der Konsole eine Zeile mit dem Namen der Funktion und ihrer Dokumentation:

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

Mit der Funktion help kann man auch die Dokumentation standardmäßiger Funktionen lesen. Lassen Sie uns Informationen über die Funktion print herausfinden:

help(print)

Um nur den Dokumentationsstring der Funktion auszugeben, muss man nach dem Funktionsnamen in help die dienstliche Konstruktion .__doc__ übergeben:

help(print.__doc__)

Erstellen Sie eine Funktion, die eine Liste von Monatsnamen als Parameter entgegennimmt und diese mit großem Anfangsbuchstaben ausgibt. Beschreiben Sie den Zweck der Funktion in der Dokumentation und geben Sie diese in der Konsole aus.

Geben Sie die gesamte Dokumentation über die Funktion sum aus.

Geben Sie nur den Dokumentationsstring über die Funktion len aus.