Kommentare

Hallo zusammen zu diesem neuen Post!

Diesmal geht´s um Kommentare. Ich gehe aus, dass jeder weiß, was Kommentare in der "Nicht-Informatik-Welt" sind.

In C# werden diese Dazu verwendet, Code zu kommentieren (wer hätte es sich denken können?). Das klingt erste einmal nach unnötiger Schreibearbeit, wir werden jedoch gleich sehen, dass es sich keineswegs um eine unnötige Erfindung handelt!

Überlegt euch, ihr arbeitet in einer Software-Firma, beispielsweise Microsoft. Die Firma arbeitet gerade an einem neuen Betriebssystem, vielleicht Windows 9 oder ein anderes. Ein Betriebssystem zu schreiben ist sicher keine leichte Arbeit und es sind viele, viele Codezeilen notwendig, sodass die Arbeit zwangsweise aufgeteilt werden muss. Jeder Entwickler übernimmt also nur einen Part der Entwicklung des Betriebssystems, aber auch das ist noch ganz schön viel Code! Ihr kehrt nun gerade braungebrannt und erholt aus eurem wohlverdienten Urlaub zurück und macht euch wieder an die Arbeit. Plötzlich sitzt ihr wieder vor Tausend Zeilen Code und habt keine Ahnung mehr, was ihr vor (max.) 6 Wochen dabei gedacht habt, als ihr diese oder jene Zeile Code geschrieben habt. Da sind z. B. Variablennamen, von denen ihr keine Ahnung habt, was sie bedeuten und für was sie überhaupt existieren. Das Ergebnis: stundenlange Wiedereinarbeitungszeiten. Nicht gerade das, was man sich unter Programmieren vorstellt! Noch schlimmer wird es, wenn man Code von seinen Kollegen bekommt, da man diesen nie geschrieben hat. Jeder Mensch vergibt seine Variablennamen nach anderen Kriterien, also kann es sein, dass da plötzlich eine Variable namens "a" existiert. Na toll!

Kommentare verhindern genau das. Mit ihnen findet man sich auch in fremdem Quellcode gut zurecht.

In C# gibt es 3 Kommentararten, von denen wir uns heute nur 2 genau anschauen werden, da für die dritte Kenntnisse in der Dokumentationssprache XML (genauere Infos dazu hier) nötig sind.

1. Die erste und wohl am häufigsten genutzte Kommentarart sieht z. B. folgendermaßen aus: //dies ist ein Kommentar Ein Kommentar dieser Art wird mit zwei Slashs. Alles, was danach folgt ist ein Kommentar und wird vom Compiler ignoriert. Das eignet sich natürlich besonders dann, wenn in einem Programm ein Fehler auftritt, man aber nicht genau weiß, wo und wieso. Natürlich bietet sich hier die Möglichkeit an, mit Visual Studio zu debuggen, man kann aber auch einfach mal diese oder jene Zeile Code "auskommentieren" um auszuprobieren, ob in dieser Codezeile der Fehler lag, ohne die Codezeile löschen zu müssen. Außerdem ist dieser Kommentar schnell geschrieben, es gilt auch keine besonderen Regeln zu beachten
2. Die zweite Art zu kommentieren ermöglicht es, auch über mehrere Zeilen zu kommentieren. Ihr Einführungszeichen ist ein Slash gefolgt von einem Sternchen (/*), ein Abschluss des Kommentars erfolgt über ein Sternchen gefolgt von einem Slash (*/). Alles zwischen diesen Zeichen ist ein Kommentar. Es ist allerdings nicht möglich, die Kommentare zu verschachteln
3. Die dritte Kommentarart, die wir aber hier nicht behandeln wollen, ist etwas komplizierter, da man XML-Kentnisse benötigt. Die Ergebnisse sind zu sehen, wenn man im Visual Studio einen Klassennamen oder einen Methodennamen eingibt: Rechts erscheint eine Dokumentation, die die Funktion der Klasse/Mehtode/Variablen kurz beschreibt sowie die Exceptions, die auftreten können.

Vielen Dank fürs Lesen und bis zur Fortsetzung der Variablen,
Julian