Python lernen, 5. Auflage

Kapitel 15. Das Dokumentations-Intermezzo

Diese Arbeit wurde mithilfe von KI übersetzt. Wir freuen uns über dein Feedback und deine Kommentare: [e-mail]

Dieser Teil des Buches schließt mit einem Blick auf Techniken und Werkzeuge zur Dokumentation von Python-Code ab. Obwohl Python-Code darauf ausgelegt ist, lesbar zu sein, können ein paar gut platzierte, für Menschen zugängliche Kommentare viel dazu beitragen, dass andere die Funktionsweise deiner Programme verstehen. Wie wir noch sehen werden, enthält Python sowohl eine Syntax als auch Werkzeuge, die die Dokumentation erleichtern. Insbesondere das hier vorgestellte PyDoc-System kann die interne Dokumentation eines Moduls entweder als reinen Text in einer Shell oder als HTML in einem Webbrowser darstellen.

Obwohl es sich hierbei um ein Konzept handelt, das mit Werkzeugen zu tun hat, wird dieses Thema hier vorgestellt, weil es zum einen das Syntaxmodell von Python betrifft und zum anderen als Ressource für Leser dient, die Schwierigkeiten haben, die Werkzeuge von Python zu verstehen. Zu letzterem Zweck werde ich hier auch auf die Hinweise zur Dokumentation eingehen, die zuerst in Kapitel 4 gegeben wurden. Da dieses Kapitel seinen Teil abschließt, gibt es neben dem Kapitelquiz wie üblich auch einige Warnungen vor häufigen Fallstricken und eine Reihe von Übungen für diesen Teil des Textes.

Quellen für die Python-Dokumentation

An dieser Stelle des Buches hast du wahrscheinlich schon gemerkt, dass Python eine erstaunliche ...