Einführung in Kommentare und Lesbarkeit von Code

Kommentare werden verwendet, um Code zu erklären und besser lesbar zu machen. Der Python-Interpreter ignoriert sie, und sie wirken sich nicht auf die Ausführung des Programms aus.

In dieser Lektion lernen Sie, wie Sie Kommentare verwenden und sauberen, gut lesbaren Code schreiben.

Einzeilige Kommentare

Einzeilige Kommentare beginnen mit einem #. Alles, was in dieser Zeile nach dem # steht, wird von Python ignoriert. Zum Beispiel:

# This is a single-line comment
print("Hello, World!")

Mehrzeilige Kommentare

Mehrzeilige Kommentare können mit dreifachen Anführungszeichen (''' oder """) geschrieben werden. Zum Beispiel:

"""
This is a multi-line comment.
It spans multiple lines.
"""
print("Hello, World!")

Warum Kommentare verwenden?

Kommentare helfen dabei:

• Komplexen Code zu erklären.
• Code für andere und für Ihr zukünftiges Ich verständlicher zu machen.
• Fehler zu finden und zu beheben.

Denken Sie daran: Kommentare sind für Menschen da, nicht für die Maschine!

Gute Vorgehensweisen für Kommentare

Hier sind einige Tipps zum Schreiben guter Kommentare:

• Halten Sie Kommentare kurz und aussagekräftig.
• Vermeiden Sie offensichtliche Kommentare wie # Increment x by 1 für x = x + 1.
• Verwenden Sie Kommentare, um zu erklären, warum der Code auf eine bestimmte Weise geschrieben ist.

Lesbarkeit von Code verbessern

Lesbarer Code lässt sich leichter warten und debuggen. Hier sind einige Tipps:

• Verwenden Sie aussagekräftige Namen für Variablen und Funktionen.
• Halten Sie Codezeilen kurz.
• Organisieren Sie den Code mithilfe von Kommentaren in Abschnitte.

Code auskommentieren

Sie können Kommentare verwenden, um Code zum Debuggen vorübergehend zu deaktivieren. Zum Beispiel:

# print("This line is commented out and won’t run.")
print("This line will run.")

Beispiel: Eine Funktion dokumentieren

Sie können Kommentare verwenden, um Funktionen zu dokumentieren und ihren Zweck zu erklären:

def greet(name):
    # This function greets the user by their name.
    print("Hello,", name)

greet("Alice")

Was haben wir gelernt?

In dieser Lektion haben Sie gelernt:

• Wie Sie einzeilige und mehrzeilige Kommentare in Python schreiben.
• Wie wichtig Kommentare für die Lesbarkeit und Wartbarkeit von Code sind.
• Bewährte Vorgehensweisen zum Schreiben von Kommentaren und Verbessern der Lesbarkeit von Code.

Sehr gut! Fahren wir mit dem nächsten Thema fort.