Python #5: Kommentare

In den letzten Kapiteln haben wir einiges an Quellcode geschrieben nun kann es vorkommen das einige Zeilen bei der Ausführung nicht berücksichtig werden sollen.
Wir könnten natürlich die Zeilen löschen oder zeitweise in die Zwischenablage Ausschneiden (Strg + X). 
Am einfachsten ist es jedoch das Stück Quellcode auszukommentieren, dazu nutzt man die Raute „#“.

Die Ausgabe ist:

Wie wir sehen entfällt die Ausgabe für „Hallo Max“. 

Im Quellcode selber wird die Zeile besonders hervorgehoben, wenn man die IDE jupyther verwendet ist dieses grau (andere IDE’s können andere Einstellungen dafür haben).

Als Kommentar kann jede beliebige Zeichenkette stehen, es muss also kein gültiger Python Code stehen. 
Kommentare werden zusätzlich benutzt um einen Quellcode an einer bestimmten stelle zu Dokumentieren.  Jedoch muss man dabei darauf achten das der Kommentar selber nicht veraltet!

Möchte man jedoch mehrere Zeilen Auskommentieren so kann man entweder vor jeder Zeile eine Raute setzten oder aber man nutzt drei einfache Anführungszeichen “ “‘ “ 

Damit kann man ganze Blöcke einfach Auskommentieren und somit entfällt bei langem Quellcode das lästige setzen und entfernen von der Raute.

Die Entwicklungsumgebung Eclipse unterstützt den Entwickler durch einen bequemen Shortcut Strg+Shift+7. 

Die Ausgabe ist:

Wenn man jedoch ein Quellcodeverwaltungssystem (CVS, SVN, Git, Mercury oder ähnliches) verwendet, so kann man sich, soweit der Code bereits eingecheckt ist, das Auskommentieren sparen. Denn warum sollte der Code noch zu sehen sein wenn dieser bereits für Obsolet erklärt wurde? Dieses vorgehen macht den Quellcode übersichtlicher und deutlich schlanker.

 

 

 

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.