Numpy Docstring

Numpy Docstring ist die Kurzform einer Numpy -Dokumentationszeichenfolge. Numpy Docstrings bieten eine bequeme Möglichkeit, die Dokumentation mit Numpy -Modulen, Funktionen, Klassen und Methoden zu verbinden. In diesem Leitfaden lernen wir, wie man die Dokstrings in Numpy erstellt, und wir werden versuchen zu verstehen, wann, wie und wo sie verwendet werden. DocStrings sind mehrzeilige Kommentare in Funktionen, Methoden, Modulen, Klassen usw. Lassen Sie uns vor dem Erlernen der Docstrings verstehen, was die multiline Kommentare sind.

Da wir bereits wissen, wie man die Multiline -Kommentare schreibt, können wir entweder die dreifachen einzelnen Zitate oder die dreifachen Doppelzitate verwenden. Wir verwenden eine Dokumentationszeichenfolge, wenn wir unsere Funktionen beschreiben möchten, damit wir die Dokumentation erhalten, wenn wir sie brauchen. Einige IDEs bieten Ihnen Dokumentation, indem Sie nur über den Namen schweben und einige bestimmte Schlüsselwörter hervorheben. Tatsache ist jedoch, dass Docstrings in Numpy viel flexibler sind als in anderen Sprachen. DocString ist ein Zeichenfolgenliteral, das zu Beginn der Funktionsdefinition auftritt. Wir müssen spezifische Werte bereitstellen, während wir die DocStrings in Funktionen, Klassen usw. verwenden, usw.

Bei Verwendung von Docstrings mit Funktionen müssen wir die Argumente verabschieden. Wenn wir sie mit Klassen verwenden, übergeben wir die Attribute und Methoden. Bei Modulen müssen wir eine Liste von Klassen und Funktionen bereitstellen. Im Falle des Pakets übergeben wir die Liste der Module mit Funktionalität. Im Grunde genommen ist der Zweck des Dokuments, wie der Name erklärt, bei der Dokumentation unseres Codes hilft. Wir führen Dokumentation durch, damit jemand, wenn er in Zukunft unseren Code verwendet, unseren Code und die Logik hinter unserem Code mit Hilfe von DocString verstehen kann. Integrierte Funktionen enthalten auch Docstrings; Wir können die Funktion von Help () verwenden, um die Dokumentation integrierter Funktionen zu betrachten.

Es gibt einige Unterschiede zwischen Kommentaren und Docstrings. Kommentare werden von Dolmetschern ignoriert, aber Docstrings werden von Dolmetschern nicht ignoriert. Speicher wird für Docstrings zugewiesen. Ein Kommentar ist eine Beschreibung des Code.

Syntax:

Die Syntax zum Schreiben der Docstrings in Numpy ist:

"" "Docstring -Nachricht" "" "
Oder
"DocString -Nachricht"

Bitte beachten Sie, dass docString keine Funktion oder Methode ist, daher keine ordnungsgemäße Syntax hat. Das einzige, was hier zu beachten ist. Wir schreiben unsere Beschreibung des Codes und beenden ihn erneut mit drei einzelnen Zitaten oder drei Doppelzitaten am Ende. Es gibt keine obligatorische Sache für Docstrings zu schreiben. Sie müssen nur drei einzelne oder doppelte Zitate vor und nach Ihrer Zeichenfolge beschreiben.

Beispiel 1:

Um die Dokstrings besser zu verstehen, führen wir ein Beispiel durch. In diesem Beispiel deklarieren wir nach Einbeziehung der Numpy -Bibliothek einfach die Variable "A" und eine andere Variable "B". Danach erstellen wir unsere Docstring mit "Lassen Sie uns" A "und" B "Variablen hinzufügen". In unserem Fall ist dies ein einfaches Beispiel, aber wenn unser Code komplex ist, hilft dies dem Codierer sehr, den Code zu verstehen. Danach fassen wir die Variablen "A" und "B" zusammen und speichern ihre Ausgabeergebnisse zu einer anderen Variablen, die "C" ist. Schließlich drucken wir den Wert der Variablen „C“ aus. Jetzt führen wir unseren Code aus.

Numph als NP importieren
a = 1
B = 2
"Lassen Sie uns A- und B -Variablen hinzufügen"
c = a+b
drucken (c)

Dies ist unsere Ausgabe aus dem angegebenen Code -Stück. Wir können sehen, dass das System keinen Fehler in Bezug auf eine falsche Syntax oder irgendetwas für Zeile 7 unseres Code. Außerdem hat das System unseren Dokument nicht gedruckt. Stattdessen druckte es nur die Ausgabe unserer Variablen „C“, in der wir unserem System ausdrucken sollen. Dies zeigt, wie die Docstrings funktionieren. Wenn ein neuer Kodierer das nächste Mal versucht, an unserem Code zu arbeiten, wird er verstehen, was wir mit Hilfe unseres Docstring tun. Es wird jedoch nicht als Ausgabe gedruckt, sodass der Benutzer des Codes nicht dadurch gestört wird.

Beispiel 2:

Jetzt führen wir ein komplexes Beispiel, um die Arbeit des Docstring zu verstehen. Zuerst schließen wir die Numpy -Bibliothek ein und schreiben dann eine DOC -Zeichenfolge, in der wir die nächste Codezeile erklären, in der wir die Initialisierung des Arrays erläutern. 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 Arbeit und den Zweck dieses Codes zu kennen. Er muss zuerst nach den Funktionen suchen, die wir verwendet haben. Wenn wir jedoch unserem Code einen DocString hinzufügen, ist es für die anderen Entwickler einfach, den Code zu verstehen, ohne mehr über die Funktionen zu lernen. Wir sind nicht darauf beschränkt, einige Grenzen zu addieren. Kommentare können von einer oder mehr als einer Zeile sein. Es kann auch mehr als einmal in einem Code hinzugefügt werden. Dann importieren Sie Numpy als NP.

"Erstellen der Variablen, an die wir eine Reihe von Größe 1x6 übergeben werden"
Array = np.Array ([11, 22, 33, 44, 55, 66])
"Zuweisen des Arrays der Funktion toFile (), damit es in der Datei mit dem Namen arr gespeichert wird."
Array.OFOFILE ("arr.Behälter")
"Zeigen Sie die Datei mit der von der Dateifunktion angezeigten Datei an"
drucken (np.aus file ("arr.bin ", dType = int))

Wie im folgenden Snippet gezeigt, werden Docstrings nicht in der Ausgabe angezeigt, was bedeutet, dass dies nicht die Ausgabe oder Kompilierung des Codes beeinflusst. Docstrings werden während des Zusammenstellungsprozesses ignoriert.

Abschluss

In diesem Leitfaden haben wir von Docstrings in Numpy erfahren. 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. Darüber hinaus haben wir versucht zu erklären, was die Docstrings in Numpy sind und wie sie mit Hilfe von Beispielen arbeiten. Schließlich bemerkten wir, dass sie für Codierer 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 der beliebteste. Es wird in der Programmiergemeinschaft häufig verwendet, um sich gegenseitig über die Arbeit und Funktionalität ihrer Codes informieren zu lassen. Dieser Leitfaden hilft Ihnen dabei, mit Numpy Docstrings zu beginnen. Wir haben versucht, das meiste von dem abzudecken, was Sie mit den Docstrings in Numpy benötigen werden.