Mathesis Wiki

Diese Seite ist nicht editierbar. Sie können den Quelltext sehen, jedoch nicht verändern. Kontaktieren Sie den Administrator, wenn Sie glauben, dass hier ein Fehler vorliegt.

====== Der Nutzen von doc-Strings ======

In jeder Definition von Funktionen, Methoden oder Klassen können wir in 'triple-quotes'
einen String angeben, der auch über mehrere Zeilen gehen darf. Dieser wird als Information
zu der jeweiligen Funktion gespeichert. Wenn wir zu einer solchen Funktion dann mit help(...) Informationen
abrufen, bekommen wir diese so gennannten **doc-Strings** angezeigt.


<code python>
def f(x,y):
   '''Berechnet das geometrische Mittel zweier Zahlen'''
   if x>0 and y>0:
       return (x*y)**0.5
   else:
       raise Exception('Geometrisches Mittel nur für positive Zahlen definiert')
</code>

Gibt man anschließend im Interpreter 'help(f)' ein, so erscheint

<code>
     Help on function f in module __main__:

       f(x, y)
       Berechnet das geometrische Mittel zweier Zahlen
</code>

Das ist sehr hilfreich, wenn man längere Programme schreibt, da man zu vergessen geruht, was man früher geschrieben hat.

Ein weiterer Mechanismus, der bisher wenig beachtet wurde, wird hier verwendet. Wenn die Argumente der Funktion nicht gewissen Anforderungen genügen, wird eine Fehlermeldung erhoben und das Programm abgebrochen (falls man nicht anderweitig dafür sorgt, dass mit den Fehlern anders umgegangen wird.)

Mathesis Wiki

Benutzer-Werkzeuge

Webseiten-Werkzeuge

Seiten-Werkzeuge