In diesem Artikel erfahren Sie mehr über C # -Kommentare, verschiedene Arten von Kommentaren sowie warum und wie Sie sie in einem Programm verwenden.
Kommentare werden in einem Programm verwendet, um das Verständnis eines Codes zu erleichtern. Es sind vom Menschen lesbare Wörter, die den Code lesbar machen sollen. Kommentare werden vom Compiler vollständig ignoriert.
In C # gibt es drei Arten von Kommentaren:
- Einzeilige Kommentare (
//) - Mehrzeilige Kommentare (
/* */) - XML-Kommentare (
///)
Einzeilige Kommentare
Einzeilige Kommentare beginnen mit einem doppelten Schrägstrich //. Der Compiler ignoriert alles nach //dem Ende der Zeile. Beispielsweise,
int a = 5 + 7; // 5 und 7 hinzufügen
Hier Adding 5 and 7ist der Kommentar.
Beispiel 1: Verwenden eines einzeiligen Kommentars
// Hello World Program using System; namespace HelloWorld ( class Program ( public static void Main(string() args) // Execution Starts from Main method ( // Prints Hello World Console.WriteLine("Hello World!"); ) ) )
Das obige Programm enthält 3 einzeilige Kommentare:
// Hallo Weltprogramm // Ausführung Startet von der Hauptmethode
und
// Druckt Hello World
Einzeilige Kommentare können in einer separaten Zeile oder zusammen mit den Codes in derselben Zeile geschrieben werden. Es wird jedoch empfohlen, Kommentare in einer separaten Zeile zu verwenden.
Mehrzeilige Kommentare
Mehrzeilige Kommentare beginnen mit /*und enden mit */. Mehrzeilige Kommentare können sich über mehrere Zeilen erstrecken.
Beispiel 2: Verwenden eines mehrzeiligen Kommentars
/* This is a Hello World Program in C#. This program prints Hello World. */ using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( /* Prints Hello World */ Console.WriteLine("Hello World!"); ) ) )
Das obige Programm enthält 2 mehrzeilige Kommentare:
/ * Dies ist ein Hello World-Programm in C #. Dieses Programm druckt Hello World. * /
und
/ * Druckt Hello World * /
Hier haben wir möglicherweise bemerkt, dass es nicht obligatorisch ist, dass sich ein mehrzeiliger Kommentar über mehrere Zeilen erstreckt. /*… */kann anstelle von einzeiligen Kommentaren verwendet werden.
Kommentare zur XML-Dokumentation
XML-Dokumentationskommentar ist eine Besonderheit in C #. Es beginnt mit einem dreifachen Schrägstrich ///und wird verwendet, um einen Code kategorisch zu beschreiben. Dies erfolgt mithilfe von XML-Tags in einem Kommentar. Diese Kommentare werden dann verwendet, um eine separate XML-Dokumentationsdatei zu erstellen.
Wenn Sie mit XML nicht vertraut sind, lesen Sie Was ist XML?
Beispiel 3: Verwenden eines XML-Dokumentationskommentars
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Der im obigen Programm verwendete XML-Kommentar lautet
/// /// Dies ist ein Hallo-Welt-Programm. ///
Die generierte XML-Dokumentation (XML-Datei) enthält:
Hallo Welt
Besuchen Sie XML Documentation Comments, wenn Sie mehr erfahren möchten.
Verwenden Sie Kommentare richtig
Kommentare werden verwendet, um Teile des Codes zu erklären, sollten jedoch nicht überbeansprucht werden.
Beispielsweise:
// druckt Hello World Console.WriteLine ("Hello World");
Die Verwendung eines Kommentars im obigen Beispiel ist nicht erforderlich. Es ist offensichtlich, dass die Zeile Hello World druckt. Kommentare sollten in solchen Fällen vermieden werden.
- Stattdessen sollten Kommentare im Programm verwendet werden, um komplexe Algorithmen und Techniken zu erklären.
- Kommentare sollten kurz und sachlich sein, anstatt eine lange Beschreibung.
- Als Faustregel ist es besser , anhand von Kommentaren zu erklären, warum statt wie .
