C# Kommentare meistern: Arten, Best Practices und XML-Dokumentation

C# Kommentare

In diesem Artikel lernen Sie C# Kommentare, verschiedene Kommentarstile und warum und wie Sie sie effektiv in einem Programm einsetzen.

Kommentare sind das Lebenselixier lesbaren Codes. Es sind für Menschen lesbare Anmerkungen, die Absichten erklären, komplexe Logik klären und Designentscheidungen dokumentieren. Der Compiler ignoriert sie vollständig, sodass sie die Laufzeitleistung nicht beeinflussen.

Laut Microsofts offizieller Dokumentation unterstützt C# drei primäre Kommentarstile:

1. Einzeilige Kommentare (//)
2. Mehrzeilige Kommentare (/* */)
3. XML-Dokumentationskommentare (///)

---

Einzeilige Kommentare

Einzeilige Kommentare beginnen mit einem doppelten Schrägstrich // und reichen bis zum Zeilenende. Alles nach // wird vom Compiler ignoriert.

int a = 5 + 7; // 5 und 7 addieren

Hier ist 5 und 7 addieren der Kommentar.

Beispiel 1: Einzeiliger Kommentar verwenden

// Hello World Programm
using System;
namespace HelloWorld {
    class Program {
        public static void Main(string[] args) // Ausführung beginnt bei Main
        {
            // Gibt Hello World aus
            Console.WriteLine("Hello World!");
        }
    }
}

Das obige Programm enthält drei einzeilige Kommentare:

// Hello World Programm
// Ausführung beginnt bei Main
// Gibt Hello World aus

Obwohl Sie einen Kommentar auf derselben Zeile wie Code platzieren können, ist es Best Practice, Kommentare auf separaten Zeilen zu halten, um Unübersichtlichkeit zu vermeiden.

---

Mehrzeilige Kommentare

Mehrzeilige Kommentare beginnen mit /* und enden mit */. Sie können sich über mehrere Zeilen erstrecken und eignen sich ideal für Block-Erklärungen oder das vorübergehende Deaktivieren von Codeblöcken.

Beispiel 2: Mehrzeiliger Kommentar verwenden

/* Dies ist ein Hello World Programm in C#.
   Dieses Programm gibt Hello World aus. */
using System;
namespace HelloWorld {
    class Program {
        public static void Main(string[] args) {
            /* Gibt Hello World aus */
            Console.WriteLine("Hello World!");
        }
    }
}

Das Programm enthält zwei mehrzeilige Kommentare:

/* Dies ist ein Hello World Programm in C#. Dieses Programm gibt Hello World aus. */
/* Gibt Hello World aus */

Beachten Sie, dass ein einzelner /* … */ Block einen einzeiligen Kommentar ersetzen kann, wenn Kürze gewünscht ist.

---

XML-Dokumentationskommentare

XML-Dokumentationskommentare beginnen mit drei Schrägstrichen /// und ermöglichen Entwicklern, strukturierte Metadaten direkt im Code einzubetten. Diese Kommentare werden von Tools wie Visual Studio extrahiert, um externe XML-Dokumentationsdateien zu generieren, die von IDEs für IntelliSense-Tooltips und von Dokumentationsgeneratoren verwendet werden können.

Falls Sie neu in XML sind, siehe Was ist XML?.

Beispiel 3: XML-Dokumentationskommentar verwenden

/// <summary>
/// Dies ist ein Hello World Programm.
/// </summary>
using System;
namespace HelloWorld {
    class Program {
        public static void Main(string[] args) {
            Console.WriteLine("Hello World!");
        }
    }
}

Der XML-Kommentar im Beispiel ist:

/// <summary>
/// Dies ist ein Hello World Programm.
/// </summary>

Die generierte XML-Datei würde etwa so aussehen:

<?xml version="1.0"?>
<doc>
<assembly>
<name>HelloWorld</name>
</assembly>
<members>
</members>
</doc>

Für tiefere Einblicke besuchen Sie XML-Dokumentationskommentare.

---

Kommentare richtig einsetzen

Effektive Kommentare klären die Absicht, ohne den Code zu überladen. Überkommentieren kann die Logik verschleiern, während zu wenige Kommentare die Wartung erschweren.

Betrachten Sie dieses Beispiel:

// Gibt Hello World aus
Console.WriteLine("Hello World");

Ein Kommentar hier ist redundant; der Code ist selbsterklärend. Nutzen Sie Kommentare stattdessen, um:

• Nicht offensichtliche Algorithmen oder Geschäftslogik zu erklären.
• Annahmen, Randfälle oder potenzielle Fallstricke hervorzuheben.
• Den Zweck eines Blocks kurz zu beschreiben, fokussiert auf das „Warum“ statt das „Wie“.

Denken Sie daran: Knappe, zweckmäßige Kommentare sind ein Markenzeichen professioneller Codebasen.