Kommentare im Code

5.1 Wie man Kommentare schreibt

In Python, wie in vielen Programmiersprachen, kann man Kommentare im Code schreiben. Kommentare helfen Programmierern und anderen Projektbeteiligten, den Code zu verstehen, was besonders bei Teamarbeit und langfristiger Wartung von Programmen nützlich ist. In Python gibt es mehrere Möglichkeiten, Kommentare hinzuzufügen.

Einstellige Kommentare:

Beginnen mit dem Symbol #. Alles, was nach dem # in derselben Zeile folgt, wird von Python ignoriert. Dieser Kommentartyp wird normalerweise für kurze Anmerkungen oder Erklärungen zu einer bestimmten Codezeile verwendet. Beispiel:

# Dies ist ein einzeiliger Kommentar
print("Hello, World!") # Erklärung zur Funktion

Mehrzeilige Kommentare:

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

# Dies ist ein Beispiel für einen mehrzeiligen Kommentar
# Jede Zeile beginnt mit dem Symbol #
      

oder:

"""
Dies ist ein mehrzeiliger Literal, der als Kommentar verwendet werden kann.
Python interpretiert es als String, tut aber nichts mit diesem String,
wenn er keiner Variablen zugewiesen oder in einem Ausdruck verwendet wird.
"""
    
      

5.2 Warum Kommentare schreiben?

Die Verwendung von Kommentaren im Code erhöht seine Lesbarkeit, erleichtert die Wartung und Aktualisierung und fördert 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 überladen.

Dokumentenstrings (docstrings):

Das sind Strings, die normalerweise am Anfang von Modulen, Klassen, Methoden und Funktionen platziert werden, um deren Zweck zu beschreiben. Sie sind in dreifache Anführungszeichen eingeschlossen und können für die automatische Generierung von Dokumentation verwendet werden.

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 Programmierwelt fügen Entwickler manchmal ihrem Code Kommentare hinzu, die nicht nur als Erklärungen dienen, sondern auch ein Lächeln hervorrufen. Hier sind einige Beispiele für lustige Kommentare, die man im Code finden kann:

Beispiel 1

 

            # Ich würde erklären, was hier passiert, aber selbst mir ist es nicht mehr klar.
        

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.

Diese Kommentare können Leichtigkeit und Humor in den Entwicklungsprozess einbringen und den Code weniger monoton machen. Sie können auch als Erinnerung dienen, dass Softwareentwicklung ein kreativer und menschlicher Prozess ist.

5.3 Code schnell kommentieren

In PyCharm kannst du Code schnell kommentieren oder entkommentieren, indem du Tastenkombinationen verwendest. Markiere dazu die Codezeilen, die du ändern möchtest, und drücke Ctrl + / auf Windows (oder Cmd + / auf macOS). Diese Tastenkombination fügt das Kommentarzeichen in jeder markierten Zeile hinzu oder entfernt es, wodurch der Prozess schnell und effizient wird.