Kommentare in Python: Python Kommentare im Überblick

Manchmal fällt es uns oder anderen schwer, unseren eigenen Code zu lesen.
Um uns und anderen das Leben etwas leichter zu machen, sind Kommentare ein äußerst nützliches Werkzeug, deswegen zeigen wir euch, wie man Kommentare in Python verwenden kann.

Einzeilige Python Kommentare

Ein einzeiliger Kommentar wird in Python durch ein # eingeleitet.

# einzeiliger Kommentar
# zweite Zeile

Allerdings kann ein einzeiliger Kommentar auch am Ende der Zeile stehen.

print(2 ** 10) # Zeigt die zehnte Potenz von 2 in der Kommandozeile

Output:

1024

Am Ergebnis des letzten Beispiels siehst du, dass die Anwesenheit des Kommentars keinen Einfluss auf die Ausführung des Codes hat.

Mehrzeilige Kommentare

Mehrzeilige Kommentare kannst du durch drei “ oder drei ‘ einleiten und auch genauso wieder beenden.

'''
mehrzeiliger Kommentar
zweite Zeile
'''

Genau genommen handelt es sich um eine Stringnotation für mehrzeilige Strings und kann genau so verwendet werden.

string = f'''
Die fünfte Potenz von 2 ist {2 ** 5}
Die achte Potenz von 2 ist {2 ** 8}
Die neunte Potenz von 2 ist {2 ** 9}
'''
print(string)

Output:

Die fünfte Potenz von 2 ist 32
Die achte Potenz von 2 ist 256
Die neunte Potenz von 2 ist 512

Docstrings

Mehrzeilige Kommentare können, wenn sie z.B. direkt nach einer Funktionsdefinition stehen auch als Dokumentation, sogenannte docstrings, verwendet werden.

def is_string(obj):
    '''
    Überprüft, ob das als Parameter übergebene Objekt vom Typ String ist
    
    :param Objekt, von dem überprüft werden soll, ob es sich um einen String handelt
    :returns Gibt True oder False zurück
    :rtype bool
    '''
    if isinstance(obj, str):
        return True
    else:
        return False

Manche Editoren sind in der Lage diesen Text bei der automatischen Vervollständigung anzuzeigen.

Fazit

Kommentare verwenden ist einfach und wenn diese sinnvoll und gut strukturiert sind, können sie uns das Leben sehr vereinfachen. Vor allem ist es wichtig am Anfang der Karriere, wenn man gerade mit dem Python lernen beginnt, die Grundbausteine richtig zu setzen!
Kommentare können auch zur Dokumentation dienen und uns helfen, unsere eigenen Funktionen mit einer Beschreibung in unserer Entwicklungsumgebung anzeigen zu lassen und helfen uns somit, unseren Code oder die Idee zu einem Code auch später noch (leichter) verstehen zu können.

Hast du noch Fragen? Anregungen? Schreib es mir bitte in die Kommentare!