logo

Python-Kommentare: Bedeutung, Typen und korrekte Verwendung

Kommentare in Python sind die Zeilen im Code, die vom Interpreter während der Ausführung des Programms ignoriert werden.








# I am single line comment> > > ''' Multi-line comment used> print('Python Comments') '''>



>

>

Kommentare verbessern die Lesbarkeit des Codes und helfen den Programmierern, den Code sehr genau zu verstehen. Es hilft auch bei der Zusammenarbeit mit anderen Entwicklern, da das Hinzufügen von Kommentaren die Erklärung des Codes erleichtert.

Arten von Kommentaren in Python

In Python gibt es drei Arten von Kommentaren:

  • Einzeilige Kommentare
  • Mehrzeilige Kommentare
  • String-Literale
  • Docstring-Kommentare

Kommentare in Python

Im Beispiel ist das zu sehen Python Kommentare werden vom Interpreter während der Ausführung des Programms ignoriert.

Python3




# sample comment> name>=> 'geeksforgeeks'> print>(name)>

>

>

Ausgabe:

geeksforgeeks>

Warum werden Kommentare in Python verwendet?

Kommentare sind ein wesentlicher Bestandteil von Programmiersprachen und jede Sprache verfügt über unterschiedliche Möglichkeiten, Kommentare zu verwenden.

Wie in jeder anderen Sprache erfüllen Kommentare in Python folgenden Zweck:

  1. Verbessern Sie die Lesbarkeit des Codes
  2. Anderen Code erklären
  3. Code verstehen, wenn man ihn nach einiger Zeit studiert
  4. Dokumentieren der Schritte und Anforderungen für eine Funktion
  5. Code mit anderen Entwicklern teilen
  6. Zusammenarbeit mit mehreren Personen.

Arten von Kommentaren in Python

Lassen Sie uns die verschiedenen Arten von Kommentaren entdecken, wie und wann man sie verwendet.

1. Einzeilig Kommentare

  • Einzeilige Python-Kommentare beginnen mit dem Hashtag-Symbol (#) ohne Leerzeichen und dauern bis zum Ende der Zeile.
  • Wenn der Kommentar eine Zeile überschreitet, fügen Sie in der nächsten Zeile einen Hashtag ein und fahren Sie mit dem Python-Kommentar fort.
  • Die einzeiligen Kommentare von Python haben sich als nützlich erwiesen, um kurze Erklärungen für Variablen, Funktionsdeklarationen und Ausdrücke bereitzustellen. Sehen Sie sich den folgenden Codeausschnitt an, der einen einzeiligen Kommentar demonstriert:

Beispiel:

Python3


Fmovies Indien



# Print techcodeview.com ! to console> print>(>'techcodeview.com'>)>

>

>

Ausgabe

techcodeview.com>

2. Mehrzeilige Kommentare

Python bietet keine Option dafür mehrzeilige Kommentare . Es gibt jedoch verschiedene Möglichkeiten, mehrzeilige Kommentare zu schreiben.

a) Mehrzeilige Kommentare mit mehreren Hashtags (#)

Wir können mehrere Hashtags (#) verwenden, um mehrzeilige Kommentare in Python zu schreiben. Jede einzelne Zeile wird als einzeiliger Kommentar betrachtet.

Python3




# Python program to demonstrate> # multiline comments> print>(>'Multiline comments'>)>

>

>

Ausgabe

Multiline comments>

Überprüfen Sie auch: Interessante Tatsache über mehrzeilige Python-Kommentare

3. String-Literale

Python ignoriert das String-Literale die keiner Variablen zugewiesen sind, sodass wir diese String-Literale als Python-Kommentare verwenden können .

a) Einzeilige Kommentare mit String-Literalen

Wenn wir den obigen Code ausführen, können wir sehen, dass es keine Ausgabe gibt, also verwenden wir die Zeichenfolgen mit dreifache Anführungszeichen () als mehrzeilige Kommentare.

Python3




Python-Druck auf 2 Dezimalstellen

'This will be ignored by Python'>

>

>

b) Mehrzeilige Kommentare mit String-Literalen

Python3




''' Python program to demonstrate> >multiline comments'''> print>(>'Multiline comments'>)>

Alter des Schauspielers Ranbir Kapoor

>

>

Ausgabe

Multiline comments>

4. Dokumentenzeichenfolge

  • Python-Dokumentzeichenfolge sind die String-Literale mit dreifachen Anführungszeichen, die direkt nach der Funktion erscheinen.
  • Es wird verwendet, um Dokumentation zu verknüpfen, die mit Python-Modulen, -Funktionen, -Klassen und -Methoden geschrieben wurde.
  • Es wird direkt unter den Funktionen, Modulen oder Klassen hinzugefügt, um zu beschreiben, was sie tun. In Python wird der Docstring dann über das Attribut __doc__ zur Verfügung gestellt.

Beispiel:

Python3




def> multiply(a, b):> >'''Multiplies the value of a and b'''> >return> a>*>b> > > # Print the docstring of multiply function> print>(multiply.__doc__)>

>

>

Ausgabe:

Multiplies the value of a and b>

Vorteile von Kommentaren in Python

Kommentare werden im Allgemeinen für folgende Zwecke verwendet:

  • Lesbarkeit des Codes
  • Erläuterung des Codes oder der Metadaten des Projekts
  • Verhindern Sie die Ausführung von Code
  • Um Ressourcen einzubeziehen

Richtige Art, Kommentare zu schreiben

Kommentare dienen hauptsächlich dazu, Ihren Code zu erklären. Entwickler verwenden eine gesunde Kommentarschreibpraxis, um den Code besser zu verstehen.

Einige der Tipps, die Sie befolgen können, um Ihre Kommentare effektiv zu gestalten, sind:

  1. Kommentare sollten kurz und präzise sein.
  2. Verwenden Sie Kommentare nur bei Bedarf. Überladen Sie Ihren Code nicht mit Kommentaren.
  3. Der Kommentar sollte eine Bedeutung haben.
  4. Vermeiden Sie es, allgemeine oder grundlegende Kommentare zu schreiben.
  5. Schreiben Sie Kommentare, die selbsterklärend sind.

Wir haben alles über Python-Kommentare besprochen, wie man Python-Kommentare schreibt, welche Arten von Kommentaren es gibt, welche Vorteile es hat und wie man Kommentare richtig schreibt.

Lesen Sie auch: Wie schreibe ich Kommentare in Python3?