Das Dokumentieren von Programmcode ist für viele eine lästige Angelegenheit. Jedoch ist es zum Einen für sich selber wichtig, den einen oder anderen Kommentar im Code zu hinterlassen, um sich nach etlichen Wochen wieder im eigenen Code zurecht zu finden, zum Anderen für Mitarbeiter oder Mitprogrammierer, die sich vielleicht in dem Code einarbeiten müssen, um ihn zu erweitern. Python bietet zur Dokumentation grundsätzlich zwei verschiedene Varianten: den einfachen Kommentar und den DocString mit den drei Anführungszeichen. In diesem Artikel hebe ich die Unterschiede der Kommentarmöglichkeiten in Python hervor, gehe etwas näher auf die DocStrings ein und nenne in diesem Rahmen einige automatischen Dokumentationsgeneratoren.

[die ganze Geschichte lesen...]