🧠 Hier ist ein komplettes Cheat Sheet zu Kommentaren, Dokumentation und Code-Stil in Python – ideal für Einsteiger, Schüler und Fortgeschrittene. Es zeigt, wie man Kommentare richtig verwendet, wie man Code dokumentiert und wie man lesbaren, sauberen Python-Code schreibt.

📝 Python Cheat Sheet – Kommentare, Dokumentation & Stil

#

💬 Kommentare in Python

#

🔹 Einzeilige Kommentare

#

Verwende #, um eine Zeile zu kommentieren:

# Das ist ein Kommentar
name = "Lena"  # Kommentar am Ende einer Zeile

✅ Wird vom Interpreter ignoriert
✅ Nutze sie für Erklärungen, Hinweise oder TODOs

🔹 Mehrzeilige Kommentare (informell)

#

Mehrere #-Zeilen hintereinander:

# Dies ist ein mehrzeiliger Kommentar
# Er erklärt, was der folgende Code tut
# und warum er wichtig ist.

🔹 Docstrings (offizielle Dokumentation)

#

Verwende dreifache Anführungszeichen """ oder ''' für Dokumentation von Funktionen, Klassen und Modulen:

def begruessung(name):
    """Gibt eine Begrüßung für den angegebenen Namen zurück."""
    return f"Hallo, {name}!"

✅ Docstrings sind lesbar mit help()
✅ Werden als offizielle Beschreibung verwendet

📚 Docstring für Klassen & Methoden

#

class Schueler:
    """Repräsentiert einen Schüler mit Name und Alter."""

    def __init__(self, name, alter):
        """Initialisiert den Schüler mit Name und Alter."""
        self.name = name
        self.alter = alter

🧠 Best Practices für Kommentare

#

✅ Erkläre das „Warum“, nicht nur das „Was“
✅ Halte Kommentare aktuell – veraltete Kommentare sind verwirrend
✅ Vermeide offensichtliche Kommentare:

x = x + 1  # Erhöht x um 1  ❌ (zu offensichtlich)

✅ Nutze Kommentare für komplexe Logik, Ausnahmen oder wichtige Hinweise

🎨 Code-Stil nach PEP 8

#

🧪 TODOs & Hinweise

#

# TODO: Funktion erweitern für mehrere Namen
# FIXME: Fehler bei Eingabe von Zahlen beheben
# NOTE: Diese Funktion wird später ersetzt

✅ Praktisch für Teamarbeit und eigene Erinnerung

🔍 Kommentare vs. Docstrings

#

🧠 Merktipp für Schüler:

#

💬 Kommentare helfen dir beim Denken.
📚 Docstrings helfen anderen beim Verstehen.