Python kommentiert

Einführung

In diesem Leitfaden geht es nicht um Programmierung. In der Tat ist überhaupt kein neuer Code beteiligt. Es hat jedoch alles damit zu tun, dass der Code, den Sie schreiben.

Wenn Sie sich Open -Source -Projekte angesehen haben, haben Sie wahrscheinlich Notizen festgestellt, die von den Programmierern platziert wurden. Diese Notizen sind einfach nur Text. Die Programmiersprache kompiliert oder interpretiert sie in keiner Weise. Es ignoriert sie nur. Es weiß, dass diese Kommentare für Menschen sind, nicht für Computer.

Kommentare sind sehr wichtig. Auch wenn Sie Ihren Code nicht mit jemand anderem teilen, werden Sie auf eine Instanz stoßen, in der Sie auf etwas zurückblicken, das Sie vor langer Zeit geschrieben haben, und sich fragen: „Was habe ich hier gemacht?„Wenn Sie daran interessiert sind, an einem Open -Source -Projekt zu arbeiten, das die Chancen aufweist, ist das Kommentieren, da Sie dies auf einer Linux -Website lesen, noch wichtiger, wenn Sie dies auf einer Linux -Website lesen. Das Letzte, was Sie wollen, ist, dass Ihr Verpflichtung abgelehnt wird. Kommentare sind auch wichtig beim Systemscripting. Es gibt nur sehr wenige IT-Abteilungen mit Einzelpersonen, und Ihre Mitarbeiter werden nicht glücklich sein, wenn sie nicht wissen, was in Ihren Skripten los ist.

Kommentar in Python

Wie viele andere Sprachen hat Python zwei verschiedene Arten von Kommentaren, Single und Multi Line. Einzelzeilen -Kommentare eignen sich hervorragend zum Hinzufügen eines kurzen Kommentars vor einem Codeblock oder direkt nach einer Codezeile, in der erklärt wird, was er tut. Multi-Line-Kommentare sind nützlich, um einem Code einen Header oder eine detailliertere Beschreibung hinzuzufügen. Sie eignen sich auch hervorragend zum Aussagen eines Codeblocks, damit er nicht ausgeführt wird. Dies eignet sich hervorragend zum Debuggen.

Einzelzeilenkommentare

In Python beginnt ein einzelner Zeilenkommentar mit a #. Dies ist ein ziemlich häufiges Symbol für die Sprachen von Skripten. Hier ist ein Beispiel dafür, wie Sie einen einzigen Zeilenkommentar als Beschreibung verwenden würden.

a = 10 b = 15 a = b # Setzen Sie A gleich B -Druck (a + b) 

Der Code wird genau so ausgeführt, wie er es tun würde, wenn der Kommentar nicht da wäre. Der Kommentar ist nur für Sie da.

Sie können auch einen einzelnen Zeilenkommentar verwenden, um zu sagen, was die nächsten Codezeilen tun werden.

# Importieren Sie die mathematische Bibliothek Mathematik # Führen Sie den pythagoräischen Satz A = 3 B = 4 C = Math aus.sqrt (a ** 2 + b ** 2) 

Auch wenn es ein einfaches Beispiel ist, dass Sie Jut wahrscheinlich herausfinden könnten, indem Sie es sich ansehen. Stellen Sie sich die Zeit vor, die in einem komplexeren Projekt gespeichert werden würde.

Schauen Sie sich nun an, wie Sie einen einzelnen Zeilenkommentar verwenden können, um zu verhindern, dass eine Codezeile ausführt.

a = 10 b = 15 # a = b Was passiert, wenn a nicht gleich B -Druck (A + B) festgelegt ist 

Die Linie, die eingestellt ist A gleich B lief nicht und gab ein anderes Ergebnis als das vorherige Beispiel

Multi-Line-Kommentare

In Python können Sie einen multi-line-Kommentar mithilfe verwenden "" " Vor und nach dem Code, den Sie ausgeben möchten. Natürlich können Sie dies auch für längere Textkommentare wie Header -Informationen verwenden.

"" "Python Test Author = Ihr Name zuletzt aktualisiert = 1. November 2016 Python Version - 3.4.3 Versionsnummer = 1.0.0 "" " 

Nichts davon bedeutet etwas für einen Computer, aber es ist hervorragend, um den Fortschritt eines Projekts zu dokumentieren. Wenn Sie solche Informationen in Projektdateien beibehalten, hat sich keine Auswirkungen auf das tatsächliche Programm, aber es ermöglicht Ihnen und allen anderen, an dem Projekt zu arbeiten, schnelle und einfache Zugriff auf wichtige Informationen. Dies eignet sich hervorragend für die Dokumentation von kollaborativen Projekten mit mehreren Dateien und mehreren Autoren. Denken Sie daran, dass die meisten realen Projekte komplex sein werden. Daher ist es eine gute Angewohnheit, in den Code zu dokumentieren.

Multi-Line-Kommentare sind auch für das Debuggen unerlässlich. Angenommen, Sie haben gerade eine neue Funktion in Ihrem Projekt implementiert, aber dieser neue Code verursacht einen Fehler. Sie können ganze Abschnitte davon kommentieren, um die Funktionalität der neuen Funktionen Stück für Stück zu testen, bis Sie endlich herausfinden, wo das Problem ist. Sagen Sie, das Beispiel „Pythagoräische Theorem“ von oben war Teil eines Merkmals, das versagte. Sie könnten so etwas wie den Code unten machen.

# Importieren Sie die mathematische Bibliothek importieren mathematik "" fehlschlägt - Bitte debuggen # Führen Sie den pythagoräischen Satz A = 3 b = 4 c = SQRT (a ** 2 + b ** 2) "" 

Sie können auch mehrzeilige Kommentare verwenden, um ein altes Code zu stoppen, während Sie ihn ersetzen. Das Löschen von Code ist normalerweise normalerweise nicht die beste Praxis. Sobald Sie es gelöscht haben, ist es nicht weg. Das Aussagen dieses Code verhindern, dass er ausführt.

Abschluss

Kommentarcode ist wichtig. Das kann nicht überbewertet werden. Es mag langweilig und langweilig erscheinen. Es hat nicht den Blitz, eine neue Killer -Linie zu schreiben, die eine Funktion implementiert, aber auf lange Sicht werden Sie sich freuen, dass diese Kommentare da sind. Kommentare sind auch ein unschätzbares Debugging -Tool, mit dem Sie ein solides Verfahren zum Testen eines fehlerhaften Code -Stücks bieten können. Üben Sie weiterhin mit Kommentaren und sehen Sie, wie sie sich auf den Codefluss auswirken können, wenn sie Zeilen oder Codeblöcke beseitigen.

Inhaltsverzeichnis

1. Python Einführung und Installationshandbuch
2. Python -Dateien und der Interpreter
3. Experimentieren mit Zahlen und Text in Python
4. Python -Variablen
5. Arbeiten mit Zahlenvariablen in Python
6. Python String Basics
7. Fortgeschrittene Python -Saiten
8. Python kommentiert
9. Python -Listen
10. Python -Listenmethoden
11. Python Mehrdimensionale Listen
12. Python Tupel
13. Python Boolean Operatoren
14. Python wenn Aussagen
15. Python während der Loops
16. Python für Schleifen
17. Python -Wörterbücher
18. Python Advanced Dictionaries
19. Python -Funktionen

Verwandte Linux -Tutorials:

• Python reguläre Ausdrücke mit Beispielen
• Installieren Sie Arch Linux in VMware Workstation
• Wie man mit der Woocommerce -REST -API mit Python arbeitet
• So erstellen Sie eine Tkinter -Anwendung mithilfe eines objektorientierten…
• Wie man Git -Repositories mit Python verwaltet
• GDB -Debugging -Tutorial für Anfänger
• Advanced Bash Regex mit Beispielen
• Dinge zu installieren auf Ubuntu 20.04
• Schleifen mit Beispielen verprügeln
• Hung Linux System? Wie man zur Befehlszeile entkommt und…