Python Kommentare

Inhalt

Kommentare dienen dazu Anmerkungen für sich oder andere im Code einzufügen. Ein Kommentar beginnt in Python mit # :

				
					# ich bin ein Kommentar
				
			

Alles was hinter dem Raute-Symbol folgt wird von Python ignoriert, selbst wenn es ich um eine Python Anweisung handelt:

				
					# print("Hallo Welt!")
				
			

Normalerweise würde die obige Anweisung „Hallo Welt!“ ausgeben. Da aber das Raute-Symbol vor der Anweisung steht wird diese von Python ignoriert. Aus der Anweisung wird ein Kommentar. 

Durch Kommentare können somit Code Zeilen schnell „auskommentiert“ werden. Das Auskommentieren wird gerne während der Programmierung verwendet, etwa um zu Code zu testen. 

Für was sind Kommentare gut?

Obwohl Kommentare nicht ausgeführt werden und damit keinen direkten Einfluss auf dein Programm haben, sind diese für Programmierer oft sehr nützlich.

U.a. werden Kommentare eingesetzt für:

  • die Erläuterung von Code oder Funktionen: Nicht immer ist sofort ersichtlich was ein Code Block genau gemacht, ein Kommentar hilft dir und anderen schwierige Abschnitte in deinem Programm schneller zu verstehen
  • das Festhalten von To-dos: sind noch einige Baustellen offen, können diese mit Kommentaren gekennzeichnet werden. Manche Editoren erkennen das Wort „todo“ in Kommentaren und erstellen dir automatisch eine Liste mit allen offenen Todos
  • die Notierung von Meta-Informationen: wer hat das Programm geschrieben? Unter welcher Lizenz steht der Code? …

Kein Allheilmittel

Kommentare gehören für viele zu ein guten Programmierstil. Nicht immer sind diese jedoch angebracht. Ein Code mit viel „Bla bla“ kann schnell unübersichtlich werden.

Für geübte Programmierer lässt sich oft schnell erfassen was ein bestimmter Code Block bewirkt. Ein Kommentar ist dann überflüssig.

Auch kann man Funktionsnamen oft auch so wählen, dass aus diesen hervorgeht für was die Funktion steht. Auch so kann man unnötige Kommentare vermeiden.