2.2. Python Style Guide#
Guido van Rossum, der Autor von Python, hat mal bemerkt, dass Code viel öfter gelesen als geschrieben wird. Für das Coden mit Python gibt es deswegen einen allgemein anerkannten Style Guide, der Konventionen festlegt, wie Code über die Syntaxregeln hinaus geschrieben werden soll: Zum Beispiel soll jede Zeile Code ungefähr 80 Zeichen haben und an bestimmten Stellen sollen zur Lesbarkeit Leerzeichen verwendet werden. Nur, wenn die Einhaltung der Richtlinien den Code weniger lesbar oder uneinheitlich machen würde, kann von den Richtlinien abgewichen werden. In diesem Kurs richten wir uns nach den Empfehlungen des Style Guides. Wenn ihr im Laufe des Semesters unsicher seid, wie ihr Code am besten schreibt, dann könnt ihr auch selbst auf den Seiten des Style Guides nachschlagen. Wenn ihr noch tiefer einsteigen wollt, lest euch das Dokument “The Elements of Python Style” durch. Darin wird diskutiert, wann es sinnvoll ist, von dem Style Guide abzuweichen und es werden Empfehlungen für komplexeren Code gemacht.
Guido van Rossum, Barry Warsaw, and Nick Coghlan. PEP 8 - Style Guide for Python Code. 2013. URL: https://peps.python.org/pep-0008/.
Andrew Montalenti et al. The Elements of Python Style. 2020. URL: amontalenti/elements-of-python-style.
2.2.1. Kommentare#
Ganz grundsätzlich gilt: Um den eigenen Code für andere verständlicher zu gestalten und sich selbst an seinen Code zu erinnern, sollte man diesen immer gut kommentieren.
# Das ist ein Kommentar