Python3-Kommentare

In Python beeinflussen Kommentare die Programmausführung nicht, aber sie machen den Code leichter lesbar und verständlicher.

Kommentare in Python umfassen:Einzeilige KommentareundMehrzeilige Kommentare。

Einzeilige Kommentare

In Python verwenden einzeilige Kommentare## am Anfang,#Der gesamte Text nach dem #-Symbol wird als Kommentar behandelt und nicht vom Interpreter ausgeführt.

Beispiel

# Dies ist ein Kommentar
print("Hello, World!")
# Dies ist ebenfalls ein Kommentar

Mehrzeilige Kommentare

In Python können mehrzeilige Strings (Textblöcke, die von drei einfachen Anführungszeichen'''oder drei doppelten Anführungszeichen"""umschlossen sind) als mehrzeilige Kommentare verwendet werden.

1. Verwendung von drei einfachen Anführungszeichen

Beispiel

#!/usr/bin/python3

'''
Dies ist ein mehrzeiliger Kommentar, der drei einfache Anführungszeichen verwendet
Dies ist ein mehrzeiliger Kommentar, der drei einfache Anführungszeichen verwendet
Dies ist ein mehrzeiliger Kommentar, der drei einfache Anführungszeichen verwendet
'''
print("Hello, World!")

2. Verwendung von drei doppelten Anführungszeichen

Beispiel

#!/usr/bin/python3

"""
Dies ist ein mehrzeiliger Kommentar, der drei doppelte Anführungszeichen verwendet
Dies ist ein mehrzeiliger Kommentar, der drei doppelte Anführungszeichen verwendet
Dies ist ein mehrzeiliger Kommentar, der drei doppelte Anführungszeichen verwendet
"""
print("Hello, World!")

Hinweis: Obwohl mehrzeilige Zeichenketten hier als mehrzeilige Kommentare verwendet werden, sind sie tatsächlich Zeichenketten. Solange wir sie nicht verwenden, beeinträchtigen sie den Programmablauf nicht.

Diese Zeichenketten können an einigen Stellen im Code platziert werden, ohne tatsächlich ausgeführt zu werden, wodurch der Effekt von Kommentaren erzielt wird.

Hinweise zu mehrzeiligen Kommentaren

In Python werden mehrzeilige Kommentare durch drei einfache Anführungszeichen'''oder drei doppelte Anführungszeichen"""definiert,diese Art von Kommentar kann nicht verschachtelt werden.。

Wenn Sie einen mehrzeiligen Kommentarblock beginnen, behandelt Python alle nachfolgenden Zeilen als Kommentare, bis es auf eine weitere Gruppe aus drei einfachen Anführungszeichen oder drei doppelten Anführungszeichen trifft.

Das Verschachteln mehrzeiliger Kommentare führt zu Syntaxfehlern:

Beispiel (Falsch)

'''
Dies ist der äußere mehrzeilige Kommentar
Er kann einige beschreibende Inhalte enthalten

    '''
Dies ist ein Versuch, einen mehrzeiligen Kommentar zu verschachteln
Dies führt zu einem Syntaxfehler
    '''
'''

In diesem Beispiel werden die drei inneren einfachen Anführungszeichen nicht korrekt als Ende des mehrzeiligen Kommentars erkannt, sondern als gewöhnliche Zeichenkette interpretiert, was zu einer fehlerhaften Codestruktur führt.

Korrektes Vorgehen: einzeilige Kommentare zum Verschachteln verwenden

Beispiel (korrekt)

'''
Dies ist der äußere mehrzeilige Kommentar
Er kann einige beschreibende Inhalte enthalten

# Dies ist ein innerer einzeiliger Kommentar
# Er kann in einen mehrzeiligen Kommentar verschachtelt werden
'''

Docstring (Dokumentationsstrings)

Der Docstring von Python (Dokumentationsstring) ist ein spezieller Kommentar, der verwendet wird, um Dokumentation zu Funktionen, Klassen, Modulen usw. hinzuzufügen. Er ähnelt dem Javadoc von Java, ist aber leistungsfähiger und flexibler.

Anders als gewöhnliche Kommentare,können Docstrings direkt über das__doc____doc__-Attribut abgerufen werden,oder Sie können diehelp()help()-Funktion verwenden, um sie anzuzeigen.

Grundlegende Syntax

Docstrings verwenden drei doppelte Anführungszeichen"""oder drei einfache Anführungszeichen'''um sie einzuschließen, und werden am Anfang einer Funktion, Klasse oder eines Moduls platziert.

Beispiel

def add(a, b):
    """Gibt die Summe zweier Zahlen zurück"""
    return a + b

# Zugriff über das __doc__-Attribut
print(add.__doc__)  # Ausgabe: Gibt die Summe zweier Zahlen zurück

Verwenden von help() zum Anzeigen der Dokumentation

Beispiel

def add(a, b):
    """Gibt die Summe zweier Zahlen zurück"""
    return a + b

# Die Funktion help() verwenden
help(add)

Erwartete Ausgabe:

Help on function add in module __main__:

add(a, b)
    返回两数之和

Verwenden des inspect-Moduls zum Extrahieren der Dokumentation

Die Python-Standardbibliothek bietet dasinspectinspect-Modul, das Dokumentationsinhalte direkt extrahieren kann:

Beispiel

import inspect

def add(a, b):
    """Gibt die Summe zweier Zahlen zurück"""
    return a + b

# Verwenden Sie inspect.getdoc(), um die Dokumentation abzurufen
print(inspect.getdoc(add))  # Ausgabe: Gibt die Summe zweier Zahlen zurück

Erwartete Ausgabe:

Return the sum of two numbers

Mehrzeiliger Docstring

Für komplexe Funktionen können Sie mehrzeilige Docstrings verwenden:

Beispiel

def calculate(a, b, operation="add"):
    """
Mathematische Operationen ausführen

Parameter:
a: Die erste Zahl
b: Die zweite Zahl
operation: Der Operationstyp, optional "add", "subtract", "multiply"

Rückgabe:
Das Berechnungsergebnis
    """
    if operation == "add":
        return a + b
    elif operation == "subtract":
        return a - b
    elif operation == "multiply":
        return a * b
    else:
        raise ValueError("Nicht unterstützte Operation")

# Vollständige Dokumentation anzeigen
help(calculate)

Erwartete Ausgabe:

Help on function calculate in module __main__:

calculate(a, b, operation='add')
    执行数学运算

    Arguments:
        a: 第一个数字
        b: 第二个数字
        operation: 操作类型，可选 "add", "subtract", "multiply"

    返回:
        计算结果

Klassen-Docstring

Docstrings können auch für Klassen verwendet werden:

Beispiel

class Person:
    """Person-Klasse, dient zur Darstellung der grundlegenden Informationen einer Person"""

    def __init__(self, name, age):
        """
Initialisiert ein Personenobjekt

Parameter:
name: Name
age: Alter
        """
        self.name = name
        self.age = age

    def introduce(self):
        """Diese Person vorstellen"""
        return f"Mein Name ist {self.name}, und ich bin {self.age} Jahre alt"

# Zugriff auf die Klassendokumentation
print(Person.__doc__)

# Zugriff auf die Methodendokumentation
print(Person.introduce.__doc__)

Erwartete Ausgabe:

Person class, used to represent basic information about a person
Introduce this person

Docstring-Konventionen

In Python gibt es mehrere Docstring-Stile. Zu den gängigen gehören:

  • Google-Stil: Verwendet Leerzeichen zur Einrückung, mit klaren Bezeichnungen für Parameter und Rückgabewerte.
  • Sphinx/reST-Stil: Verwendet einen Doppelpunkt am Anfang, wie zum Beispiel:param name:。
  • NumPy-Stil: Ähnlich wie der Google-Stil, aber mit leicht abweichender Formatierung.

Es wird empfohlen, in Ihrem Projekt einen Stil zu wählen und konsistent beizubehalten.

Weitere Erweiterungen