Chapter 11. Python-Code dokumentieren
Dieses Kapitel beendet Part III mit einer Betrachtung von Techniken und Werkzeugen für die Dokumentation von Python-Code. Obwohl Python so entworfen ist, dass Code im Allgemeinen sehr lesbar ist, können einige Kommentare an der richtigen Stelle für den menschlichen Leser sehr hilfreich sein, um zu erklären, wie Ihre Programme funktionieren. Python unterstützt Kommentare sowohl mit seiner Syntax als auch mit Werkzeugen, die die Dokumentation leichter machen. Dieses Konzept hat mehr mit Werkzeugen zu tun, aber wir haben das Thema trotzdem an dieser Stelle aufgenommen, eben weil die Syntax von Python eine Rolle spielt und auch, damit Leser, die diese Werkzeuge gern verstehen möchten, eine Stelle zum Nachschlagen ...
Get Einfüehrung in Python now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
