Da wir bereits wissen, wie man mehrzeilige Kommentare schreibt, können wir entweder die dreifachen einfachen Anführungszeichen oder die dreifachen doppelten Anführungszeichen verwenden. Wir verwenden eine Dokumentationszeichenfolge, wenn wir unsere Funktionen beschreiben möchten, damit wir die Dokumentation abrufen können, wenn wir sie benötigen. Einige IDEs geben Ihnen Dokumentation, indem Sie einfach mit der Maus über den Namen fahren, und einige heben bestimmte Schlüsselwörter hervor. Tatsache ist jedoch, dass Docstrings in NumPy viel flexibler sind als in anderen Sprachen. Docstring ist ein Zeichenfolgenliteral, das am Anfang der Funktionsdefinition steht. Wir müssen bestimmte Werte angeben, wenn wir die Docstrings in Fällen von Funktionen, Klassen usw. verwenden.
Bei der Verwendung von Docstrings mit Funktionen müssen wir die Argumente übergeben. Bei der Verwendung mit Klassen übergeben wir die Attribute und Methoden. Im Fall von Modulen müssen wir eine Liste von Klassen und Funktionen bereitstellen. Beim Paket übergeben wir die Liste der Module mit Funktionalität. Im Grunde ist der Zweck des Docstring also, wie der Name schon sagt, dass er bei der Dokumentation unseres Codes hilft. Wir machen Dokumentation, damit jemand, der unseren Code in Zukunft verwendet, unseren Code und die Logik hinter unserem Code mit Hilfe von docstring verstehen kann. Eingebaute Funktionen haben auch Docstrings in sich; Wir können die Funktion von help() verwenden, um uns den Docstring der eingebauten Funktionen anzusehen.
Es gibt einige Unterschiede zwischen Kommentaren und Dokumentzeichenfolgen. Kommentare werden von Interpretern ignoriert, aber Docstrings werden von Interpretern nicht ignoriert. Speicher wird für Dokumentzeichenfolgen zugewiesen. Ein Kommentar ist eine Beschreibung des Codes, aber andererseits teilen uns Docstrings den Zweck des Codes mit.
Syntax:
Die Syntax zum Schreiben der Docstrings in NumPy lautet:
'''Docstring-Nachricht'''
Oder
'''Docstring-Nachricht'''
Bitte beachten Sie, dass docstring keine Funktion oder Methode ist und daher keine korrekte Syntax hat. Das einzige, was hier zu beachten ist, ist, dass wir den Docstring mit drei einfachen oder drei doppelten Anführungszeichen beginnen. Wir schreiben unsere Beschreibung des Codes und beenden ihn wieder mit drei einfachen Anführungszeichen oder drei doppelten Anführungszeichen am Ende. Für Docstrings muss nichts zwingend geschrieben werden. Sie müssen nur drei einfache oder doppelte Anführungszeichen vor und nach Ihrer Zeichenfolgenbeschreibung setzen.
Beispiel 1:
Um die Docstrings besser zu verstehen, führen wir ein Beispiel durch. In diesem Beispiel deklarieren wir nach dem Einbinden der NumPy-Bibliothek einfach die Variable „a“ und eine weitere Variable „b“. Danach erstellen wir unseren Docstring mit der Aufschrift „Lassen Sie uns die Variablen „a“ und „b“ hinzufügen“. In unserem Fall ist dies ein einfaches Beispiel, aber wenn unser Code komplex ist, hilft dies dem Programmierer sehr, den Code zu verstehen. Danach summieren wir die Variablen „a“ und „b“ und speichern ihr Ausgabeergebnis in einer anderen Variablen, die „c“ ist. Abschließend geben wir den Wert der Variablen „c“ aus. Jetzt führen wir unseren Code aus.
importieren taub wie z.B.a = 1
b = zwei
'''Lasst uns Variablen a und b hinzufügen'''
c = a+b
drucken ( c )
Dies ist unsere Ausgabe aus dem angegebenen Codestück. Wir können sehen, dass das System keinen Fehler bezüglich falscher Syntax oder irgendetwas für Zeile 7 unseres Codes ausgegeben hat. Außerdem hat das System unseren Docstring nicht gedruckt. Stattdessen druckte es nur die Ausgabe unserer Variablen „c“, in der wir unserem System sagten, dass es drucken soll. Dies zeigt, wie die Docstrings funktionieren. Wenn ein neuer Programmierer das nächste Mal versucht, an unserem Code zu arbeiten, wird er mit Hilfe unseres Docstrings verstehen, was wir tun. Aber es wird nicht als Ausgabe gedruckt, damit der Benutzer des Codes nicht dadurch gestört wird.
Beispiel 2:
Jetzt führen wir ein komplexes Beispiel durch, um die Funktionsweise des Docstrings zu verstehen. Zuerst binden wir die NumPy-Bibliothek ein und schreiben dann einen Doc-String, in dem wir die nächste Codezeile erklären, in der wir die Initialisierung des Arrays erklären. Wir fügen auch die Docstrings im anderen Teil des Codes hinzu. Wenn wir diesen Code nun mit einem neuen Python-Entwickler teilen, ohne die Docstrings hinzuzufügen, wird es für ihn irgendwie schwierig sein, die Funktionsweise und den Zweck dieses Codes zu kennen. Er muss zuerst nach den Funktionen suchen, die wir verwendet haben. Aber wenn wir unserem Code einen Docstring hinzufügen, wird es für die anderen Entwickler einfach sein, den Code zu verstehen, ohne mehr über die Funktionen zu lernen. Wir sind nicht darauf beschränkt, einigen Limits Kommentare hinzuzufügen; Kommentare können ein- oder mehrzeilig sein. Es kann auch mehr als einmal in einem Code hinzugefügt werden. Importieren Sie dann NumPy als np.
'''Die Variable erstellen, an die wir ein Array der Größe 1x6 übergeben werden'''Reihe = z.B. Reihe ( [ elf , 22 , 33 , 44 , 55 , 66 ] )
'''das Array der Funktion tofile() zuweisen, damit es in der Datei namens arr gespeichert wird'''
Reihe . einordnen ( 'arr.bin' )
'''zeige die Datei mit der Funktion fromfile an'''
drucken ( z.B. aus Datei ( 'arr.bin' , dtyp = int ) )
Wie im folgenden Snippet gezeigt, werden Docstrings nicht in der Ausgabe angezeigt, was bedeutet, dass sie die Ausgabe oder Kompilierung des Codes nicht beeinflussen. Docstrings werden während des Kompilierungsprozesses ignoriert.
Fazit
In diesem Handbuch haben wir Docstrings in NumPy kennengelernt. Wir haben die Docstrings mit Kommentaren verglichen und den Unterschied zwischen beiden erklärt. Wir haben die Syntax von Docstrings gelernt und wie man die Docstrings in unseren Code schreibt. Außerdem haben wir versucht, anhand von Beispielen zu erklären, was die Docstrings in NumPy sind und wie sie funktionieren. Abschließend haben wir angemerkt, dass sie für Programmierer unerlässlich sind. Wir werden die Bedeutung von Docstrings in NumPy nicht wiederholen. Wir werden nur sagen, dass Sie die Docstrings in Ihrem Code verwenden sollten. In NumPy ist der Schreibstil von Docstrings am beliebtesten. Es wird in der Programmiergemeinschaft häufig verwendet, um sich gegenseitig über die Funktionsweise und Funktionalität ihrer Codes zu informieren. Diese Anleitung hilft Ihnen bei den ersten Schritten mit NumPy-Docstrings. Wir haben versucht, das meiste, was Sie benötigen, mit den Docstrings in NumPy abzudecken.