Um diese Webseite uneingeschränkt betrachen zu können, aktivieren Sie bitte Javascript

2018-08-01

Von: Niklas Gerken (gepr. Oliver Osmers)





Die Kommentierung von Quelltexten

Wie kommentiere ich einen Quelltext?


Jeder gute Programmierer weiß, dass Kommentare ein wichtiger Bestandteil eines Quelltextes sind. Dennoch werden sie von den meisten Anwendungsentwicklern gerne vernachlässigt. Es heißt immer: „Ich weiß doch was ich programmiert habe“. Doch nach einiger Zeit und vielen anderen Projekten, vergisst selbst der beste Programmierer, was er vor einigen Monaten oder Jahren programmiert hat. Ein weiterer Punkt für die Kommentierung ist ein Projekt, an welchen mehrere Programmierer gleichzeitig arbeiten. In diesem Fall ist es für alle Mitarbeiter nachvollziehbar, was seine Kollegen programmiert haben. Mithilfe von Kommentaren ist ein Quelltext für sich selbst, aber vor allem auch für andere Programmierer verständlicher.

 

Kommentare besitzen meistens eine grüne Schriftfarbe. Es wird zwischen einzeiligen und mehrzeiligen Kommentaren unterschieden. Einzeilige Kommentare werden mit Doppelslash „//“ oder Hochkomma dargestellt. Mehrzeilige Kommentare beginnen mit/* und enden mit */. Die Slash Variante wird häufig bei C Sprachen verwendet und das Hochkomma bei Basic Sprachen. Ein Kommentar wird idealerweise über den Programmcode platziert. An dieser Stelle können einzelne Programmzeilen oder sogar ganze Programmblöcke erläutert werden. Alternativ werden Programmcodes auch gerne hinter einer Programmzeile gesetzt. Diese Möglichkeit hat den Vorteil das sich das Kommentar genau auf eine Zeile bezieht. Letztendlich ist die Platzierung und Gestaltung eines Kommentars auch ein wenig Geschmackssache und nicht so wichtig wie der Kommentar selbst. Dennoch sollte nicht zwischen mehreren Kommentierungsarten in einem Programm gewechselt werden, da dadurch die Übersichtigkeit verloren geht. 

 

 

Ein Kommentar soll den Quelltext möglichst genau und kurz beschreiben. Dabei soll nicht Zeile für Zeile das Ersichtliche beschrieben werden, sondern vielmehr der Hintergedanke und die Absicht des Programmierers. Kommentare sind an den entsprechenden Stellen sehr wichtig, um einen Programmcode leichter zu verstehen. Besonders bei komplexen Programmteilen ist es sinnvoll Kommentare zu setzen. Ganz am Anfang des Quelltextes steht der sogenannte Header. Dieser enthält die wichtigsten Informationen über den Quelltext. Zum einen enthält der Header den Namen des Programmierers inklusive Firmenname, das Datum an dem der Quelltext zuletzt bearbeitet wurde und die Versionsnummer. Zum anderen wird kurz beschrieben, was der vorliegende Programmcode für einen Nutzen hat.