Dienstag, 7. September 2010

C# Kommentare

Die Programmiersprache C# unterstützt 3 Kommentartypen:
Einzeilige Kommentare, mehrzeilige Kommentare und Dokumentationskommentare.
Einzeilige Kommentare werden durch das Zeichen // eingeleitet und gehen bis zum Ende der aktuellen Zeile:
namespace ConsoleApplication1 // dies ist ein einzeiliger Kommentar

Mehrzeilige Kommentare erstrecken sich zwischen den Zeichen /* und */ und können, wie der Name schon sagt, über mehrere Zeilen gehen:

/* Dies ist ein Kommentar,
* der über mehrere Zeilen
* geht. */


Schließlich gibt es noch Dokumentationskommentare, welche durch das Zeichen /// eingeleitet werden.
Diese sind eigentlich ein Thema für sich und gehören nicht zu den eigentlichen Codekommentaren, denn sie haben eine XML - Struktur und dienen der automatischen Codekommentierung.
Dokumentationskommentare werden direkt vor das Objekt geschrieben, dass sie kommentieren sollen, die Entwicklungsumgebung fügt automatisch bestimmte Tags hinzu.
Das Thema soll hier nicht weiter ausgeführt werden, nur ein Beispiel wie die Kommentierung für die main - Methode aussehen könnte:

/// <summary>
/// Hauptmethode des Programms
/// </summary>
/// <param name="args">Befehlszeilenargumente, mit denen das Programm aufgerufen wurde</param>

Keine Kommentare:

Kommentar veröffentlichen