So kommentieren Sie in Python

Aktualisiert im Juli 2021

Einführung

Eine Schlüsselkompetenz beim Schreiben von Code ist die Fähigkeit, Kommentare zu verwenden. Kommentare sind Zeilen, die Compiler und Interpreter ignorieren und die Entwickler verwenden, um Notizen über die Funktion des Codes zu hinterlassen. Außerdem können sie auch verwendet werden, um Teile des Codes zu deaktivieren.

Diese Anleitung zeigt Ihnen, wie Sie Kommentare in Python effektiv verwenden.

Voraussetzungen

• Eine funktionierende Python-Programmierumgebung
• Die Möglichkeit, Python-Dateien zu erstellen und zu bearbeiten

Python-Kommentar-Syntax

Um eine Zeile als Kommentar hinzuzufügen oder zu markieren, beginnen Sie mit einem Rautezeichen (# ) und ein Leerzeichen :

# This is a sample comment.

Die Verwendung des Hash-Zeichens zum Starten der Zeile weist das System an, alles in dieser Zeile zu ignorieren. Wenn die Anwendung ausgeführt wird, tut das Programm so, als ob diese Zeilen nicht existieren. Sie können es jedoch immer noch sehen, wenn Sie die Datei bearbeiten.

Zum Beispiel in Hello World Programm unten:

# Display the text "Hello, World!" on the screen.
print("Hello, World!")

Das System führt den Code print("Hello, World") aus in Zeile vier, während die Zeile darüber erklärt, was der Code tun soll.

Sie können jede Zeile als Kommentar festlegen und so viele verwenden, wie Sie möchten. Wenn Ihr Code verschiedene Blöcke hat, können Sie einen Kommentar verwenden, um jeden zu erklären. Zum Beispiel:

# Define a variable flowers as a list of strings.
flowers = [‘rose’, ‘carnation’, ‘daisy’, ‘marigold’, ‘tulip’, ‘sunflower’]

# Create a for loop to iterate through flowers list, and displays each string item.
for flower in flowers:
            print(flower)

Python-Kommentarblock

Kommentare blockieren sind längere Kommentare, die aus mehreren Zeilen hintereinander bestehen. Ein Entwickler verwendet sie, um komplexeren Code zu erklären, insbesondere wenn er im Team arbeitet.

Um eine Reihe von Zeilen als Kommentar zu markieren, fügen Sie ein Rautezeichen hinzu + Leerzeichen am Anfang jeder Zeile:

# This is a comment
# that runs on to
# multiple lines.

Einige Texteditoren oder Code-Editoren für die Programmierung (wie Notepad++ oder Atom) ermöglichen es Ihnen, den Text zu markieren und dann mit der Maus zu klicken, um den Block als Kommentar zu markieren. Mit diesen Tools können Sie Zeit sparen, indem Sie jede Zeile auskommentieren.

Mehrzeiliger Python-Kommentar

Im Allgemeinen wird die Verwendung von # empfohlen am Anfang jeder Zeile, um sie als Kommentar zu markieren. Das Kommentieren eines großen Abschnitts nimmt jedoch viel Zeit in Anspruch, und Sie benötigen möglicherweise eine schnelle Möglichkeit, einen ganzen Abschnitt auszukommentieren. In solchen Fällen können Sie mehrzeilige Kommentare verwenden .

Mehrzeilige Zeichenfolgen funktionieren nicht als traditionelle Python-Kommentare, da es keine offizielle mehrzeilige Funktionalität gibt. Verwenden Sie stattdessen mehrzeilige Zeichenfolgen, die in dreifache Anführungszeichen eingeschlossen sind (""" ), um eine ähnliche Funktion zu erreichen.

Zum Beispiel:

def addition_test(a, b):
    result = a + b
    """
    This is a block
    of commented lines.
    They aren’t parsed and interpreted by the compiler.
    """
return result

Diese Methode erstellt eine Textkonstante ohne Funktion, keinen echten Kommentar. Solange Sie nichts hinzufügen, das auf diese Textzeichenfolge zugreift, funktioniert es genauso wie ein normaler Kommentar.

Das dreifache Anführungszeichen kann schwierig sein, da es unter Umständen einen docstring erstellt wenn ein dreifaches Anführungszeichen:

• folgt einer Funktionssignatur,
• folgt einer Klassendefinition,
• steht am Anfang eines Moduls.

Wenn Sie """ platzieren an einer der oben aufgeführten Stellen liest Python es als dosctring . Mit Docstrings können Sie menschenlesbaren Text in das Projekt einfügen. Dies wird normalerweise verwendet, um Dokumentation zu erstellen, die Teil der Anwendung ist und auf die zur Laufzeit zugegriffen werden kann.

Python-Inline-Kommentar

Mit einem Inline-Kommentar können Sie in derselben Zeile wie einen Codeabschnitt kommentieren . Am besten verwenden Sie diese Option, wenn Sie eine komplizierte Operation erklären.

Verwenden Sie einen Inline-Kommentar, um genau auf die Stelle hinzuweisen, die Sie klären möchten. Fügen Sie das standardmäßige Hash-Zeichen hinzu + Leerzeichen um einen Inline-Kommentar zu kennzeichnen:

function
    set variable
    run command
    run additional command        # Tricky part:  The program breaks if this line is removed.

Inline-Kommentare werden verwendet, um Kontext für Personen hinzuzufügen, die den Code lesen. Sie können beispielsweise den Zweck einer Variablen erläutern oder eine Notiz über den Typ der erstellten Variablen hinterlassen. Es kann auch hilfreich sein, zu erklären, warum ein bestimmter Befehl verwendet wird, wie im obigen Beispiel.

Python auskommentieren

Da Kommentare Text für den Parser unsichtbar machen, können Sie sie verwenden, um Befehle zu deaktivieren. Auf diese Weise können Sie Codesegmente mit und ohne neue Ergänzungen testen.

In diesem einfachen Würfelprogramm gibt es zum Beispiel einen Abschnitt, der auskommentiert ist. Wenn Sie das Hash-Zeichen entfernen, aktivieren Sie den Code zum Testen.

import random
min = 1
max = 6

roll_again = "yes"

while roll_again == "yes" or roll_again == "y":
     print "Rolling the dice..."
     print "The values are...."
     print random.randint(min, max)
     print random.randint(min, max)

# Add two random numbers together for a sum
# while roll_again == “yes” or roll_again == “y”:
    # print ”Rolling the dice…”
    # print “You rolled a “
    # print random.randint(min,max) + random.randint(min, max)

    roll_again = raw_input("Roll the dice again?")

Warum sind Kommentare in Python wichtig

Kommentieren kann Ihnen helfen:

• Verstehen Sie Ihren eigenen Code, wenn Sie nach längerer Zeit darauf zurückkommen.
• Damit Sie schneller wieder auf Touren kommen.
• Debug-Probleme.
• Verstehen Sie bestimmte Code-Entscheidungen, wenn Sie in einem Team arbeiten.
• Verhindern Sie potenzielle Probleme, indem Sie betonen, warum ein bestimmter Codeteil wichtig ist.

Best Practices für Python-Code-Kommentare

• Kommentieren Sie an derselben Einrückung wie der Code, auf den Sie sich beziehen. Dadurch ist es einfacher zu sehen, worauf Sie sich beziehen.
• Aktualisieren Sie Ihre Kommentare, wenn Sie Ihren Code aktualisieren. Falsche Kommentare sind schlimmer als keine Kommentare.
• Verwenden Sie vollständige Sätze. Schreiben Sie entsprechende Wörter groß, es sei denn, Sie beziehen sich auf einen Bezeichner (wie eine Variable). Ändern Sie niemals die Groß-/Kleinschreibung eines Bezeichners.
• Blockkommentare sollten in ganzen Sätzen mit Punkten geschrieben werden. Streben Sie höchstens 80 Wörter pro Zeile an.
• Wenn Sie mehrere Sätze in einem Kommentar haben, verwenden Sie ein doppeltes Leerzeichen zwischen den Sätzen.
• Kommentare auf Englisch schreiben.
• Fügen Sie für einen Blockkommentar mit mehreren Absätzen eine Leerzeile zwischen den Absätzen hinzu, wobei ein einzelnes Kommentar-Tag vor einer Leerzeile steht.
• Lassen Sie bei Inline-Kommentaren mindestens zwei Leerzeichen zwischen dem Code und dem Kommentar. Verwenden Sie Inline-Kommentare sparsam und vermeiden Sie es, sie zu verwenden, um das Offensichtliche auszudrücken.

VERMEIDEN:

• Kommentieren Sie keinen selbsterklärenden Code. Halten Sie sich an das Prinzip DRY zu schreiben (D auf nicht R Wiederholen Sie Y uns selbst) und vermeiden Sie WET (W Ritus E alles T wice) Code und Kommentare.
• Vermeiden Sie die Verwendung von Kommentaren, um chaotischen Code zu erklären - Kommentare sollten Code unterstützen, nicht rechtfertigen.