Python-Kommentar

Michael Zippo 31.10.2021

Ein Python-Kommentar ist eine Textzeile in einem Programm, die nicht vom Interpreter ausgefuhrt wird. Kommentare werden w√§hrend des Debuggens verwendet, um Probleme zu identifizieren und Code zu erkl√§ren. Kommentare beginnen mit einem Rautenzeichen (#).

Kommentare bezeichnen Notizen oder Code, die Python nicht ausfuhren soll. Angenommen, Sie schreiben eine komplexe Prozedur uber einen Zeitraum von mehreren Stunden. Vielleicht m√∂chten Sie ein paar Kommentare schreiben, um den √úberblick uber die einzelnen Codezeilen zu behalten, damit Sie nicht den √úberblick verlieren.

Das Schreiben von Kommentaren ist aus mehreren Grunden nutzlich. Wenn Sie mit einem gro√üen Python-Programm arbeiten, k√∂nnen Kommentare Ihnen helfen, den √úberblick zu behalten. Kommentare helfen den Teammitgliedern auch, sicherzustellen, dass jeder die Arbeit des anderen an einem kollaborativen Projekt versteht.

Jeder Entwickler ger√§t irgendwann in eine Situation, in der er beim Schreiben von Code Kommentare einfugen muss.

Aber wie? Kommentieren Sie Code in Python? Wie jede andere Programmiersprache unterstutzt Python das Kommentieren. In diesem Leitfaden werden wir uber das Schreiben von Kommentaren in Python sprechen.

Was ist ein Python-Kommentar?

Ein Python-Kommentar ist eine Textzeile, die in einem Programm erscheint, aber wird vom Programm nicht ausgefuhrt. Sie k√∂nnen einen Kommentar mit einem Hashtag (#) deklarieren. Kommentare k√∂nnen in einer neuen Zeile oder am Ende einer bestehenden Codezeile erscheinen.

Kommentare werden verwendet, um die Funktionsweise des Codes zu erkl√§ren und zu Testzwecken.

Hier ist ein Beispiel ein einzeiliger Kommentar in Python:

81 % der Teilnehmer gaben an, dass sie sich nach dem Besuch eines Bootcamps hinsichtlich ihrer Berufsaussichten im Tech-Bereich sicherer fuhlten. Werde noch heute zu einem Bootcamp gematcht.

Der durchschnittliche Bootcamp-Absolvent verbrachte weniger als sechs Monate im Karriereubergang, vom Start eines Bootcamps bis zur Suche nach seinem ersten Job.

Sie k√∂nnen das # Hash sehen mark kennzeichnet unseren Kommentar. Wir haben unseren Kommentartext und das #-Zeichen durch ein Leerzeichen getrennt. Dies ist nicht notwendig, macht aber jeden Kommentar leichter lesbar.

Diese Zeile wird vom Compiler ignoriert, wenn wir unseren Code ausfuhren. Kommentare sind von Menschen zu lesen. Sie sind nicht fur die Ausfuhrung durch ein Programm bestimmt.

Kommentare sollten auf derselben Einruckungsebene wie der Code hinzugefugt werden, auf den sich der Kommentar bezieht. Angenommen, Sie schreiben uber eine Codezeile innerhalb einer if-Anweisung. Sie wurden Ihren Kommentar genauso einrucken wie Ihren Code.

Beispiel fur Python-Kommentare

Angenommen, Sie schreiben eine for-Schleife und m√∂chten sich daran erinnern, wie sie funktioniert. Vielleicht m√∂chten Sie a . schreiben einige Kommentare. Wenn Sie sich Ihren Code sp√§ter ansehen, k√∂nnen Sie Ihre Notizen lesen.

In einer Python for-Schleife , Sie haben m√∂glicherweise Kommentare, die wie folgt aussehen:

Unsere Kommentare helfen uns, den Zweck unseres Codes zu verstehen und den √úberblick zu behalten.

Nehmen wir ein Beispiel zur Veranschaulichung der Einruckungsstruktur e von Kommentaren in Python. Im folgenden Beispiel durchl√§uft unser Programm zwei Python-Arrays und gibt jedem Schuler ein bestanden oder nicht bestanden fur ihre Prufung. Bestehen und Nichtbestehen werden basierend auf einem Schuler‚Äô Numerische Punktzahl bei ihrem Test:

Dieses Programm erstellt eine Liste der Schuler und ihrer Noten. Dann durchl√§uft unser Programm die Liste der Studenten. Wir prufen, ob jeder Schuler seinen Test bestanden oder nicht bestanden hat.

Im obigen Beispiel k√∂nnen Sie sehen, dass wir auf derselben Einruckungsebene kommentieren wie die Zeile, auf die wir uns beziehen. Wenn wir beispielsweise uber unsere Python if-Anweisung sprechen, haben wir sowohl unseren Kommentar als auch unseren Code eingeruckt.

Durch das Schreiben dieser einzeiligen Kommentare ist unser Programm sowohl fur den Autor des Codes besser lesbar. Unser Programm ist auch fur alle anderen einfacher, die es m√∂glicherweise Sehen Sie sich unser Programm an, um es zu lesen.

Python-Inline-Kommentare

Python-Inline-Kommentare werden in derselben Zeile wie eine Anweisung geschrieben, nachdem der Code geschrieben wurde. Inline-Kommentare sollten den Zweck erl√§utern einer Codezeile oder wie es funktioniert.

Hier ist die Syntax fur einen Inline-Kommentar:

Inline-Kommentare sind nutzlich, wenn Sie komplizierte Teile des Codes erkl√§ren mussen. Sie sind auch nutzlich, wenn Sie denken, dass Sie es k√∂nnten Vergessen Sie in Zukunft, wie eine bestimmte Codezeile funktioniert.

Inline-Kommentare sind auch nutzlich, wenn Sie es sind in einem Team arbeiten und sicherstellen mussen, dass jeder eine bestimmte Zeile versteht.

Im Gegensatz zu anderen Arten von Kommentaren verwenden Sie Inline-Kommentare nur gelegentlich. Dies liegt daran, dass zu viele Inline-Kommentare ein Programm schwer lesbar machen.

Python-Mehrzeilenkommentare

Python-Mehrzeilenkommentare oder Python-Blockkommentare erkl√§ren Code, der entweder komplizierter ist oder dessen Zweck hat ist nicht sofort ersichtlich. Sie k√∂nnen einen Blockkommentar verwenden, um beispielsweise eine einzigartige Funktion zu erkl√§ren, die eine externe Bibliothek verwendet.

Blockkommentare sind mehrzeilige Kommentare in Python und gelten fur einen Teil oder den gesamten Code darunter. Blockkommentare werden wie alle anderen Kommentare auch auf derselben Ebene wie der Code, den der Kommentar behandelt, eingeruckt.

Beispiel fur mehrzeilige Kommentare

Hier ist ein Beispiel fur eine mehrzeilige Zeichenfolge, die erkl√§rt eine Python sort()-Funktion:

"Karrierekarma trat in mein Leben ein, als ich es am dringendsten brauchte und half mir schnell, ein Bootcamp zu finden. Zwei Monate nach meinem Abschluss habe ich meinen Traumjob gefunden, der meinen Werten und Lebenszielen entspricht!"

Venus, Software Engineer bei Rockbot

Unser Kommentar umfasst mehrere Zeilen und beschreibt den Zweck des darunter geschriebenen Codes.

W√§hrend einige Entwickler diesen Code verstehen, k√∂nnen andere Programmierer verwirrt sein, wie er funktioniert oder warum er geschrieben wurde Blockkommentare sind nutzlich, um anderen Code zu erkl√§ren, dessen Zweck fur einen Entwickler nicht sofort offensichtlich ist.

Schlussfolgerung

So kommentieren Sie in Python! Kommentare verwenden , k√∂nnen Sie Ihre Programme fur jeden lesbarer machen, auch fur Sie selbst.

Gut geschriebene Kommentare k√∂nnen Ihnen dabei helfen, den √úberblick uber Ihren Code zu behalten. Sie erm√∂glichen es Ihnen, Aufzeichnungen zu fuhren, auf die verwiesen werden kann zuruck zu sp√§ter, wenn Sie sp√§ter Schwierigkeiten haben, Ihren Code zu verstehen.

Sind Sie bereit fur eine Herausforderung? Schreiben Sie einen Blockkommentar oben in eines Ihrer Programme. Dieser Kommentar sollte Folgendes enthalten:

Wenn Sie die Datei erstellt haben
Der Name der Datei
Der Zweck der Datei

Versuchen Sie, Ihren Code auszufuhren. L√§uft Ihr Programm wegen des Kommentars nicht, haben Sie einen Fehler gemacht. Wenn Ihr Programm normal l√§uft, herzlichen Gluckwunsch! Sie haben erfolgreich einen Kommentar verfasst.

In diesem Tutorial haben wir untersucht, wie Kommentare, Inline-Kommentare und Blockkommentare in Python geschrieben werden. Wir haben auch besprochen, wie einige Entwickler Kommentare zum Testen schreiben. Jetzt k√∂nnen Sie Kommentare wie ein Python-Experte schreiben!

Sie m√∂chten die Programmiersprache Python beherrschen? Unterstutzung zu den wichtigsten Python-Kursen, -Buchern und -Lernressourcen finden Sie in unserem umfassenden Leitfaden zum Erlernen von Python.