Skip to Content
Python lernen, 5. Auflage
book

Python lernen, 5. Auflage

by Mark Lutz
September 2024
Intermediate to advanced
1648 pages
53h 10m
German
O'Reilly Media, Inc.
Content preview from 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: translation-feedback@oreilly.com

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 ...

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Fließendes Python, 2. Auflage

Fließendes Python, 2. Auflage

Luciano Ramalho
Python in a Nutshell, 4. Auflage

Python in a Nutshell, 4. Auflage

Alex Martelli, Anna Martelli Ravenscroft, Steve Holden, Paul McGuire

Publisher Resources

ISBN: 9781098183981