Kommentare und Regionen

Gewöhnlich verwendet man Kommentare zweierlei Weise. Zum einen kommentiert man einen Code aus, wenn man sich eine Änderung gemacht hat, aber immer die Option haben möchte es rückgängig machen zu können, zum anderen eben um z.B. eine bestimmte Funktion mit eigenen Worten zu beschreiben, damit ein anderer Entwickler sich schnell damit zurecht finden. Andererseits sei es nicht unterschätzt, dass man selbst eigenen Code nach einigen Wochen wieder verstehen lernen muss.

Ich habe bereits Codes gesehen, die eher wie ein Fußballfeld von oben gesehen aussehen, als nach einer Programmierkunst. Eine komplette grüne Landschaft ist natürlich irgendwo kontraproduktiv.

Unter C# hat man aber viel mehr Möglichkeiten etwas zu kommentieren als durch das bekannte //.

1. Der klassische Kommentar: 
[crayon-6621b36c2b387234005356/]
 2. Kommentar über mehrere Zeilen:
[crayon-6621b36c2b38c946488233/]
3. Kommentieren von Methoden/Klassen über <summery>:

Nachdem man eine Klasse/Methode geschrieben hat, kann man genau darüber einfach 3 Schrägstriche /// machen und ein summery-Kommentar wird generiert.  Die param Felder geben Auskunft über die Parameter, die gesetzt wurden.
[crayon-6621b36c2b38e685199955/]
2015-03-05_15-42-47

 

4. Regionen schaffen 

Zugegeben handelt es sich nicht um einen Kommentar, sondern um eine Möglichkeit bestimmte Teile in Regionen zu teilen um eine bessere Übersicht zu schaffen.

dies geschieht, indem man einfach
[crayon-6621b36c2b38f209603137/]
Nun kann man die Region schließen und hat einen bestimmten Codeteil sauber verpackt 🙂

2015-03-05_15-50-22