Python Docstring

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, Funktion, Klasse oder Modul im Programm zu erklären. Es hilft dem Hauptcodierer, sich nach langer Zeit an die Funktion eines jeden Codes zu erinnern, und es hilft auch anderen Codierern, die an demselben Projekt arbeiten möchten. Der Codierer verwendet eine einzige Kommentarzeile, um den jeweiligen Teil der Funktion des Codes in Kürze zu erläutern. Die Python -Dokumenten -Zeichenfolge oder Dokusstring wird verwendet, um die Funktion eines bestimmten Segments des Codes im Detail zu erläutern. Die DocString -Linie sollte mit dem Großbuchstaben beginnen und mit einer Periode enden. Die erste Zeile der DocString enthält eine kurze Beschreibung der Dokumentation im Allgemeinen. Die zweite Zeile des Docstring sollte für die große Multi-Line-Docstring leer sein. Dreifach einzelne Zitate ('”) oder dreifache Doppelzitate ("" ") werden verwendet, um die Docstring in Python zu definieren. Auf den Inhalt von DocString kann durch die Verwendung zugegriffen werden der Arzt__ Attribut des Objekts und verwenden die Hilfe() Methode. Die Art der Erklärung und Zugriff auf Docstring in Python hat in diesem Tutorial gezeigt.

Beispiel 1: Zugriff auf docstring einer Funktion mithilfe __doc__ Attribut

Die Art der Erklärung und Zugriff auf den Dokument einer benutzerdefinierten Funktion hat im folgenden Skript gezeigt. Das folgende Skript berechnet das x^N wobei X und N vom Benutzer entnommen werden. Leistung () Die Funktion hat im Skript definiert, um die Aufgabe zu erledigen. Hier wurde der DocString für diese Funktion definiert. __doc__ Das Attribut wurde im Skript verwendet, um den Dokument mit der Ausgabe zu drucken.

Def Power (x, n):
"Berechnen Sie X an die Leistung n
Lesen Sie die Werte von x und n aus den Funktionsargumenten
und berechnen und geben Sie den Wert von x an die Leistung n."
return x ** n
# Nehmen Sie den Wert von x
x = int (input ('den Wert von x:') eingeben)
# Nehmen Sie den Wert von n
n = int (input ('den Wert von n:') eingeben)
# Drucken Sie den Rückgabewert der Funnction
Druck ("Der %d zum Power %d = %d" %(x, n, Strom (x, n)))
# Den DocString -Wert ausdrucken
print ("Der Inhalt der Dokumentation: \ n" + Power.__doc__)

Ausgang:

Die folgende Ausgabe wird nach der Ausführung des obigen Skripts angezeigt.

Beispiel-2: Zugriff auf docString von Klasse und Methode mithilfe der Methode Hilfe() Methode

Die Art der Erklärung und Zugriff auf den Dokument des Dokuments und die Methoden dieser Klasse haben im folgenden Skript gezeigt. Die Hauptfunktion des Skripts besteht darin, eine numerische Liste zu sortieren und die Daten der Liste umzukehren. Eine numerische Liste von 8 Elementen wurde in der Klasse deklariert, und der DocString wurde zu Beginn der Klasse unter Verwendung von dreifachen einzelnen Zitaten 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 () Die Methode wird definiert, um die umgekehrten Daten der Liste zu drucken, und die DOCString wurde auch für diese Methode definiert. Hilfe() Die Methode hat am Ende des Skripts dreimal aufgerufen list_operations Klasse, Sortierliste() Methode und die reverse_list () Methode.

Klassenliste_operationen:

Klassenliste_operationen:
"
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 drucken.
"
# Definieren Sie eine Liste numerischer Daten
ListData = [23, 67, 23, 6, 45, 3, 90, 11]
Def sort_list (self):
"
Drucken Sie die Listenwerte nach der Sortierung aus
Die Funktion entnimmt ein Listenobjekt numerischer Daten aus dem Argument,
Sortieren Sie die Listenwerte mit der Methode Sort ()
und drucken Sie die Werte der sortierten Liste aus.
"
# Sortieren Sie die Liste
selbst.ListData.Sortieren()
# Drucken Sie die sortierte Liste mit der Schleife
print ("Die Werte der sortierten Liste: \ n")
Für Wert in sich selbst.ListData:
print (Wert, "", end = ")
Def Reverse_List (Selbst):
"
Drucken Sie die Listenwerte nach dem Umkehren aus
Die Funktion entnimmt ein Listenobjekt numerischer Daten aus dem Argument,
Umkehren Sie die Listwerte mit der Reverse () -Methode um
und drucken Sie die Werte der umgekehrten Liste aus.
"
# Die Liste umkehren
selbst.ListData.umkehren()
# Drucken Sie die umgekehrte Liste mit der Schleife aus
print ("Die Werte der sortierten Liste: \ n")
Für Wert in sich selbst.ListData:
print (Wert, "", end = ")
# Drucken Sie den docstring -Wert der Klasse
Hilfe (list_operations)
# Objekt der Klasse erstellen
obj = list_operations ()
# Drucken Sie den docstring -Wert der jeweiligen Methode
Hilfe (obj.Sortierliste)
# Rufen Sie die Methode an, um die sortierte Liste zu drucken
obj.Sortierliste()

Ausgang:

Nach der Ausführung des Skripts wird die folgende Ausgabe angezeigt. Alle DocString des Skripts wurden für das erste gedruckt Hilfe() Funktion. Die docstring der Sortierliste() Die Methode wurde für die zweite gedruckt Hilfe() Funktion.

Beispiel-3: Zugriff auf DOCString des eingebauten Python-Moduls

In den vorherigen Beispielen wurde die DocString in der benutzerdefinierten Klasse und Funktion verwendet. Jedes integrierte Python-Modul und jede Klasse haben seinen DocString, der den Zweck der Verwendung dieses bestimmten Moduls oder Funktion erklärt. Der Codierer 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 Dokument des DateTime-Moduls mithilfe des Hilfe() Funktion.

# Das DateTime -Modul importieren
DateTime importieren
# Zeigen Sie die DOCString von DateTime an
Hilfe (DateTime)

Ausgang:

Die folgende Ausgabe wird nach der Ausführung des Skripts angezeigt. Die docString des DateTime -Moduls zeigt die detaillierte Dokumentation, um den anderen zu helfen.

Abschluss:

Die ordnungsgemäße Dokumentation ist wichtig, wenn ein Modul oder eine Funktion für den spezifischen Zweck implementiert wird, um dem anderen Codierer zu helfen, das Modul in seinem Code zu verwenden, um die bestimmte Aufgabe zu erledigen. Wenn die Dokumentation für das Modul oder die Funktion nicht ordnungsgemäß definiert ist, werden die anderen Benutzer Probleme verwenden. Daher muss jeder Codierer den Dokument des Dokuments verwenden, um den anderen detaillierte Informationen bereitzustellen, um den Code zu verstehen.