Python-Code richtig dokumentieren: Docstrings, Sphinx und der Docs-as-Code-Ansatz
Softwaredokumentation ist wichtig. Bis jetzt konnten Python-Programmierer immer von gut beschriebenen öffentlichen Programmbibliotheken profitieren. Da liegt es doch auf der Hand, auch den eigenen Code so zu dokumentieren, dass er in Zukunft für einen selbst und für andere lesbar und wartbar bleibt.
Bekanntlich ist der erste Schritt oft der schwierigste. Dieser Artikel soll daher eine Einführung in die Dokumentation von Python-Code geben. Er erläutert die grundlegenden Konzepte von Docstrings, der vereinfachten Auszeichnungssprache reStructuredText und dem Dokumentationsgenerator Sphinx. Zudem zeigt er die Vorteile von Docs as Code und liefert eine Antwort auf die Frage, ob Python auch mit anderen Auszeichnungssprachen dokumentiert werden kann.
0 Kommentare