Kommentare in Python

1. Wie man Kommentare schreibt

In Python, wie in vielen anderen Programmiersprachen, kannst du Kommentare in deinem Code schreiben.

Kommentare sind einfach Text für andere Entwickler: Der Python-Interpreter reagiert nicht darauf und führt den darin enthaltenen Code nicht aus. Kommentare helfen Entwicklern und anderen Projektmitgliedern, den Code zu verstehen, was besonders nützlich bei der Zusammenarbeit und langfristigen Wartung von Programmen ist. In Python gibt es verschiedene Möglichkeiten, Kommentare in den Code einzufügen.

Einstellige Kommentare:

Sie beginnen mit dem Zeichen #. Alles, was nach # in derselben Zeile folgt, wird vom Python-Interpreter ignoriert. Diese Art von Kommentaren wird normalerweise für kurze Notizen oder Erklärungen zu einer bestimmten Codezeile verwendet. Beispiel:

# Das ist ein einzeiliger Kommentar
print("Hallo, Welt!")  # Erklärung zur Funktionsaktion

Mehrzeilige Kommentare:

In Python gibt es keinen speziellen Syntax für mehrzeilige Kommentare, aber man kann sie mit mehreren einzeiligen Kommentaren oder mit dreifachen Anführungszeichen erstellen, obwohl Letzteres tatsächlich ein mehrzeiliger String-Literal ist, der nicht als Code ausgeführt wird. Beispiel:

# Das ist ein Beispiel für einen mehrzeiligen Kommentar
# Jede Zeile beginnt mit dem Zeichen `#`

oder:

"""
Das ist ein mehrzeiliger Literal, der als Kommentar genutzt werden kann.
Python interpretiert ihn als String, macht aber nichts damit, 
wenn es keiner Variablen zugewiesen oder in einem Ausdruck verwendet wird.
"""

Nützlich! Ein Literal ist ein kleines Datenstück, das direkt im Code notiert ist, z.B. eine Zahl, ein String usw.

2. Warum sollte man Kommentare schreiben

Kommentare im Code erhöhen die Lesbarkeit, erleichtern die Wartung und Aktualisierung und fördern eine effektivere Zusammenarbeit in Teams. Kommentare sollten kurz, aber informativ und relevant sein, um als nützliche Dokumentation des Codes zu dienen und ihn nicht mit unnötigen Informationen zu überfrachten.

Dokumentierende Strings (docstrings):

Dies sind mehrzeilige Strings, die normalerweise am Anfang von Modulen, Klassen, Methoden und Funktionen platziert werden, um deren Zweck zu beschreiben. Sie werden in drei Paaren von Anführungszeichen eingeschlossen und dienen zur automatischen Generierung von Dokumentationen.

Beispiel:

def add(a, b):
    """
    Funktion zur Addition von zwei Zahlen.
    :param a: erster Summand
    :param b: zweiter Summand
    :return: Summe von a und b
    """
    return a + b

In der Welt der Programmierung fügen Entwickler manchmal ihrem Code Kommentare hinzu, die nicht nur als Erklärungen dienen, sondern auch ein Lächeln hervorrufen. Hier sind ein paar Beispiele für lustige Kommentare, die im Code auftauchen können:

Beispiel 1:

# Ich würde erklären, was hier passiert, aber selbst ich verstehe es nicht mehr.

Beispiel 2:

# Wenn das nicht funktioniert, ist jemand anderes schuld.

Beispiel 3:

# Ich kam, sah, reparierte… und brach es.

Beispiel 4:

# Als ich das schrieb, wussten nur Gott und ich, wie es funktioniert.
# Jetzt weiß es nur noch Gott.

Beispiel 5:

# Anzahl der hier verschwendeten Stunden = 42.

Solche Kommentare können der Entwicklungsarbeit eine gewisse Leichtigkeit und Humor verleihen und die Codebasis weniger monoton machen. Sie erinnern auch daran, dass Softwareentwicklung ein kreativer und menschlicher Prozess ist.

5.3 Code schnell kommentieren

In der PyCharm IDE kannst du Code schnell kommentieren oder auskommentieren, indem du Hotkeys verwendest. Markiere die Codezeilen, die du kommentieren oder auskommentieren möchtest, und drücke Ctrl + / auf Windows (oder Cmd + / auf macOS). Diese Tastenkombination fügt das Kommentarzeichen zu jeder markierten Zeile hinzu oder entfernt es, was diesen Prozess schnell und effizient macht.