Benutzer-Werkzeuge

Webseiten-Werkzeuge


Seitenleiste

ws1314:der_nutzen_von_doc-strings_und_was_doc-strings_sind

Dies ist eine alte Version des Dokuments!


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.

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')

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

<block> Help on function f in module main:

f(x, y)

  Berechnet das geometrische Mittel zweier Zahlen

</block>

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

ws1314/der_nutzen_von_doc-strings_und_was_doc-strings_sind.1391685509.txt.gz · Zuletzt geändert: 2016/05/10 14:46 (Externe Bearbeitung)