Docstrings

Eine sinnvolle und sorgfältige Dokumentation und Kommentierung des Codes ist immer zu empfehlen. Für Funktionen gibt es die Möglichkeit einen sogenannten Docstring hinzuzufügen. Dies ist ein Kommentar, der in zwei dreifachen Anführungszeichen unmittelbar nach dem Funktionskopf steht.

Ich füge hier der Funktion square_it() einen entsprechenden Docstring hinzu:

def square_it(number):
    """Gibt das Quadrat einer Zahl zurück."""
    return number * number

Diesen Kommentar können wir nun nicht nur unmittelbar im Code lesen, sondern dieser wird auch angezeigt, wenn man die Funktion help() auf die Funktion anwendet.

help(square_it)

Help on function square_it in module __main__:

square_it(number)
    Gibt das Quadrat einer Zahl zurück.

V.a. wenn Code auch von anderen genutzt und verstanden werden soll, sind Docstrings eine sinnvolle Sache. Aber auch, um selbst den Überblick über den eigenen Code zu behalten, lohnt es sich, sich die Verwendung von Docstrings anzugewöhnen.