Python-Dokumentationszeichenfolge

Die Dokumentation ist für jede Programmierung unerlässlich, um den Code leicht zu verstehen. Es wird verwendet, um den Zweck der Verwendung einer Anweisung oder Funktion oder Klasse oder eines Moduls im Programm zu erklären. Es hilft dem Hauptcoder, sich nach langer Zeit an die Funktion jedes Codes zu erinnern, und es hilft auch anderen Programmierern, die an demselben Projekt arbeiten möchten. Der Coder verwendet eine einzige Kommentarzeile, um den jeweiligen Teil der Funktion des Codes kurz zu erklären. Python document string oder docstring wird verwendet, um die Funktion eines bestimmten Abschnitts des Codes im Detail zu erklären. Die Docstring-Zeile sollte mit einem Großbuchstaben beginnen und mit einem Punkt enden. Die erste Zeile des Docstrings enthält eine kurze Beschreibung der Dokumentation allgemein. Die zweite Zeile des Docstrings sollte für den großen mehrzeiligen Docstring leer sein. Dreifache einfache Anführungszeichen ('") oder dreifache Anführungszeichen (""") werden verwendet, um den Docstring in Python zu definieren. Auf den Inhalt des Docstrings kann über zugegriffen werden der Arzt__ Attribut des Objekts und die Verwendung der Hilfe() Methode. Die Art und Weise, wie Sie Docstring in Python deklarieren und darauf zugreifen, wurde in diesem Tutorial gezeigt.

Beispiel-1: Zugriff auf den Docstring einer Funktion mit __doc__ Attribut

Die Art und Weise, wie Sie den Docstring einer benutzerdefinierten Funktion deklarieren und darauf zugreifen, wird im folgenden Skript gezeigt. Das folgende Skript berechnet die x^nein wobei x und n vom Benutzer genommen werden. Leistung () Funktion im Skript definiert hat, um die Aufgabe zu erledigen. Hier wurde der Docstring für diese Funktion definiert. __doc__ -Attribut wurde im Skript verwendet, um den Docstring mit der Ausgabe zu drucken.

Def-Leistung (x, n):
"Berechnen Sie x hoch n
Lies die Werte von x und n aus den Funktionsargumenten
und Berechnen Sie den Wert von x und geben Sie ihn hoch n zurück."
Rückgabe x**n
# Nimm den Wert von x
x = int(input('Geben Sie den Wert von x ein:'))
# Nimm den Wert von n
n = int(input('Geben Sie den Wert von n ein:'))
# Rückgabewert der Funktion ausgeben
print("Die %d hoch %d = %d" %(x, n, power(x, n)))
# Drucken Sie den docstring-Wert
print("Der Inhalt des Dokumentstrings:\n" + Macht.__doc__)

Ausgabe:

Die folgende Ausgabe wird angezeigt, nachdem das obige Skript ausgeführt wurde.

Beispiel-2: Zugriff auf den Docstring der Klasse und Methode mit Hilfe() Methode

Die Art und Weise, wie der Docstring des Dokuments und die Methoden dieser Klasse deklariert und darauf zugegriffen werden kann, wird im folgenden Skript gezeigt. Die Hauptfunktion des Skripts besteht darin, eine numerische Liste zu sortieren und die Daten der Liste umzukehren. In der Klasse wurde eine numerische Liste von 8 Elementen deklariert, und der Docstring wurde am Anfang der Klasse mit drei einfachen Anführungszeichen definiert. Die Methode sort_list() wurde in der Klasse definiert, um die sortierten Daten der Liste zu drucken, und das Dokument hat dies definiert für diese Methode. reverse_list() -Methode ist definiert, um die umgekehrten Daten der Liste zu drucken, und der Docstring wurde auch für diese Methode definiert. Hilfe() -Methode dreimal am Ende des Skripts aufgerufen hat, um den Docstring des list_operations Klasse, Sortierliste() Methode, und die reverse_list() Methode.

Klasse list_operations:

Klasse list_operations:
"
Sortieren und Umkehren der Listendaten
Die Klasse enthält zwei Methoden,
sort_list() Methode sortiert und druckt die Liste,
sort_reverse() Methode wird die Liste umkehren und ausgeben.
"
# Definiere eine Liste mit numerischen Daten
Listendaten = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list(self):
"
Drucken Sie die Listenwerte nach dem Sortieren
Die Funktion nimmt ein Listenobjekt mit numerischen Daten aus dem Argument,
Sortieren Sie die Listenwerte mit der Methode sort()
und drucke die Werte der sortierten Liste.
"
# Sortiere die Liste
selbst.Listendaten.Sortieren()
# Drucken Sie die sortierte Liste mit loop
print("Die Werte der sortierten Liste:\n")
für Wert in sich selbst.Listendaten:
print(Wert, " ", end=")
def reverse_list(self):
"
Drucken Sie die Listenwerte nach dem Reversieren
Die Funktion nimmt ein Listenobjekt mit numerischen Daten aus dem Argument,
die Listenwerte mit der reverse()-Methode umkehren
und drucke die Werte der umgekehrten Liste.
"
# Die Liste umkehren
selbst.Listendaten.umkehren()
# Drucken Sie die umgekehrte Liste mit loop
print("Die Werte der sortierten Liste:\n")
für Wert in sich selbst.Listendaten:
print(Wert, " ", end=")
# Den docstring-Wert der Klasse ausgeben
help(list_operations)
# Objekt der Klasse erstellen
obj = list_operations()
# Drucken Sie den docstring-Wert der bestimmten Methode
helfen (obj.Sortierliste)
# Rufen Sie die Methode auf, um die sortierte Liste zu drucken
obj.Sortierliste()

Ausgabe:

Die folgende Ausgabe erscheint nach der Ausführung des Skripts. Der gesamte Docstring des Skripts wurde zum ersten Mal gedruckt Hilfe() Funktion. Der Docstring der Sortierliste() Methode wurde zum zweiten Mal gedruckt Hilfe() Funktion.

Beispiel-3: Zugriff auf docstring des integrierten Python-Moduls

In den vorherigen Beispielen wurde der docstring in benutzerdefinierten Klassen und Funktionen verwendet. Jedes eingebaute Python-Modul und jede eingebaute Klasse hat ihren Docstring, der den Zweck der Verwendung dieses bestimmten Moduls oder dieser Funktion erklärt. Der Coder des Moduls oder der Funktion definiert den Docstring, um den Code für die Benutzer verständlich zu machen. Das folgende Skript druckt den vordefinierten Docstring des Datetime-Moduls mithilfe der Hilfe() Funktion.

# Datetime-Modul importieren
Datum/Uhrzeit importieren
# Zeigen Sie den Docstring von datetime an
Hilfe (Datum/Uhrzeit)

Ausgabe:

Die folgende Ausgabe erscheint nach der Ausführung des Skripts appeared. Der docstring des datetime-Moduls zeigt die detaillierte Dokumentation davon, um anderen zu helfen, die Funktionen der in diesem Modul definierten Klassen und Methoden richtig zu kennen.

Fazit:

Die ordnungsgemäße Dokumentation ist unerlässlich, wenn ein Modul oder eine Funktion für einen bestimmten Zweck implementiert wird, um dem anderen Programmierer zu helfen, das Modul in seinem Code für die jeweilige Aufgabe zu verwenden. Wenn die Dokumentation für das Modul oder die Funktion nicht richtig definiert ist, werden die anderen Benutzer Probleme bei der Verwendung haben. Jeder Programmierer muss also den Docstring des Dokuments verwenden, um detaillierte Informationen bereitzustellen, damit die anderen den Code verstehen können.