E9 Dokumentation von Funktionen - Pythonkurs (PDF)

Die Datei enthält die Präsentation „E9 Dokumentation von Funktionen - Pythonkurs“. Eine gute Unterstützung bis hierher im Kurs war immer wieder die Python-Hilfe Funktion help(), mit welcher wir uns Zusatzinformationen zu Funktionen anzeigen lassen konnten. Wir lernen in diesem Abschnitt kennen, wie wir auch für unsere selbst geschriebenen Funktionen solch eine Art von Dokumentation hinterlegen können: Kommentare sollten nicht nur im Programmtext hinterlegt sein, sondern immer auch als Hilfen innerhalb von Funktionen. Solch eine Funktions-Hilfe wird als Doc-String bezeichnet. Wichtig: Es sollte immer eine Dokumentation für eine Funktion angelegt werden! Doc-Strings werden als Hilfe in einer (guten) IDE per Hover oder Klick angezeigt. Der Abschnitt besteht aus einem ausführlich kommentierten Jupyter Notebook, mit welchem Sie selbst die besprochenen Inhalte des Abschnitts erproben können und einem Video mit zugehörigen Erklärungen des Dozenten.