{"id":182227,"date":"2026-02-18T20:48:09","date_gmt":"2026-02-18T19:48:09","guid":{"rendered":"https:\/\/liora.io\/de\/?p=182227"},"modified":"2026-02-20T08:11:19","modified_gmt":"2026-02-20T07:11:19","slug":"docstring-was-ist-das-wozu-dient-es","status":"publish","type":"post","link":"https:\/\/liora.io\/de\/docstring-was-ist-das-wozu-dient-es","title":{"rendered":"DocString: Was ist das? Wozu dient es?"},"content":{"rendered":"\n

Docstrings sind Dokumentationsketten, die sehr n\u00fctzlich sind, um Code zu teilen, ihn weiterzuentwickeln, in Gruppen zu arbeiten, Fehler zu finden und vieles mehr. Lass uns herausfinden, worum es sich dabei handelt und welche Vorteile sie bieten.<\/strong><\/p>\n\n\n\n

Definition eines DocString in Python<\/h2>\n\n\n\n

Ein DocString<\/strong> stellt die Dokumentation eines Codes dar. Dadurch k\u00f6nnen andere Entwickler<\/a> und du selbst, wenn du deinen Code wieder aufrufst, sehr leicht verstehen, wie deine verschiedenen Codeteile funktionieren.<\/p>\n\n\n\n

Du kannst deine Funktionen, Klassen, Methoden usw. dokumentieren. Diese Praxis mag \u00fcberfl\u00fcssig erscheinen, kann dir und deinen Lesern aber viel Zeit sparen. Erstens, wenn du als Team an einem Projekt arbeitest, musst du die Elemente deines Codes<\/strong> nicht m\u00fcndlich erkl\u00e4ren, was dir auch Wiederholungen erspart. Wenn dein Programm mehrere Monate nach seiner Einf\u00fchrung ge\u00e4ndert werden muss, wird derjenige, der es bearbeitet, keine Probleme haben, es zu verstehen.<\/p>\n\n\n\n

Wenn du deine Komponenten dokumentierst, wirst du gezwungen sein, einfache Funktionen zu erstellen, da dir die Komplexit\u00e4t erst durch die Dokumentation bewusst wird. Wenn ein Fehler auftritt, ist es au\u00dferdem viel einfacher, das Problem zu finden, wenn deine Komponenten klar dokumentiert sind.<\/p>\n\n\n\n

Wie benutzt man DocStrings in Python?<\/h2>\n\n\n\n

Ich werde dir nun zeigen, wie du DocStrings<\/strong> f\u00fcr deine Funktionen, Klassen und Methoden in Visual Studio Code<\/a> mit Python erstellen kannst. Installiere zun\u00e4chst die folgenden Erweiterungen: **Python** und **autoDocString – Python DocString Generator** in deinem Environment.<\/p>\n\n\n\n

Mit der autoDocString-Erweiterung<\/strong> kannst du den K\u00f6rper deines DocStrings automatisch erstellen lassen. Schreibe einfach deine Funktion, du kannst den Typ deiner Parameter und den Typ der R\u00fcckgabe angeben. Dann beginne unterhalb der Funktion mit der Eingabe der drei Anf\u00fchrungszeichen („““) und autoDocString wird dir vorschlagen, den DocString deiner Funktion auszuf\u00fcllen.<\/p>\n\n\n\n

Hier ist das Ergebnis:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Das Python-Plugin<\/a> zeigt dir Informationen \u00fcber die Funktion, Klasse oder Methode an, die du gerade benutzt. Diese Erweiterung funktioniert mit jeder Python-Funktion, aber auch mit deiner eigenen. Du musst also nicht erst das Element finden und seine Dokumentation in seiner Datei ansehen, sondern hast alles direkt zur Verf\u00fcgung.<\/p>\n\n\n\n

Hier ist ein Beispiel, das auf dem vorherigen Screenshot basiert:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Du kannst dir auch den Spa\u00df machen, die Funktion help() oder das Attribut __doc__ auf deinen Funktionen zu verwenden, um deren Dokumentation anzuzeigen.<\/p>\n\n\n\n

\n
Python f\u00fcr Data Science lernen<\/a><\/div>\n<\/div>\n\n\n\n

HTML-Dokumentationen automatisch generieren<\/h2>\n\n\n\n

Zum Schluss m\u00f6chte ich dir ein Werkzeug vorstellen, mit dem du HTML-Dokumentationen erstellen kannst: Sphinx. Ich werde dir ein kleines Tutorial vorstellen, mit dem du deine erste HTML-Dokumentation<\/strong> unter Ubuntu erstellen kannst.<\/p>\n\n\n\n

1. Erstelle einen Ordner sphinx_project\/.<\/p>\n\n\n\n

2. Erstelle in diesem Ordner den Ordner docs\/ sowie den Ordner my_math\/.<\/p>\n\n\n\n

3. Im Ordner my_math\/: Erstelle zwei Dateien „my_exp.py“ und „my_add.py“, in denen du mit Hilfe des obigen Bildes eine Funktion „my_add“ einf\u00fcgst, die die Addition von zwei Zahlen zur\u00fcckgibt. Erstelle auch eine leere Datei „__init__.py“.<\/p>\n\n\n\n

4. Installiere „sphinx“ und „sphinx-rtd-theme“ mit Hilfe von pip. Eine Liste der von Sphinx angebotenen Themen findest du unter https:\/\/sphinx-themes.org\/.<\/p>\n\n\n\n

5. Starte im Ordner docs\/ den Befehl „sphinx-quickstart“. Gib bei der ersten Frage „Enter“ ein, dann deinen Projektnamen, deinen Namen und dann zweimal „Enter“. Dieser Befehl erstellt Ordner und Quelldateien, um Sphinx zu verwenden.<\/p>\n\n\n\n

6. F\u00fchre im Ordner sphinx_project\/ den Befehl „sphinx-apidoc -o docs .“ aus. Dieser Befehl erstellt zwei „.rst“-Dateien, die es Sphinx erm\u00f6glichen, HTML-Code zu erstellen, der auf den rekursiv gefundenen „.py“-Dateien basiert.<\/p>\n\n\n\n

7. Nun m\u00fcssen wir die Datei „docs\/index.rst“ bearbeiten und „modules“ hinzuf\u00fcgen. Wir weisen Sphinx an, die Dokumentation nach der Konfigurationsdatei „modules.rst“ zu erstellen.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

8. Bearbeite nun die Datei „docs\/conf.py“, die wie folgt aussehen sollte:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

In dieser Datei haben wir :<\/p>\n\n\n\n