C#-Kommentare

C#-Kommentare

In diesem Artikel erfahren wir mehr über C#-Kommentare, verschiedene Kommentarstile und warum und wie man sie in einem Programm verwendet.

Kommentare werden in einem Programm verwendet, um uns dabei zu helfen, ein Stück Code zu verstehen. Sie sind für Menschen lesbare Wörter, die den Code lesbar machen sollen. Kommentare werden vom Compiler vollständig ignoriert.

In C# gibt es 3 Arten von Kommentaren:

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

---

Einzeilige Kommentare

Einzeilige Kommentare beginnen mit einem doppelten Schrägstrich // . Der Compiler ignoriert alles nach // bis zum Ende der Zeile. Zum Beispiel

int a = 5 + 7; // Adding 5 and 7

Hier, Adding 5 and 7 ist der Kommentar.

Beispiel 1:Verwendung 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:

// Hello World Program
// Execution Starts from Main method

und

// Prints 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 endet mit */ . Mehrzeilige Kommentare können sich über mehrere Zeilen erstrecken.

Beispiel 2:Verwendung 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:

/*
This is a Hello World Program in C#.
This program prints Hello World.
*/

und

/* Prints Hello World */

Hier ist uns vielleicht aufgefallen, dass ein mehrzeiliger Kommentar nicht zwingend über mehrere Zeilen gehen muss. /* … */ kann anstelle von einzeiligen Kommentaren verwendet werden.

---

XML-Dokumentationskommentare

Der XML-Dokumentationskommentar ist ein spezielles Feature in C#. Es beginnt mit einem dreifachen Schrägstrich /// und wird verwendet, um ein Stück Code kategorisch zu beschreiben. Dies geschieht mithilfe von XML-Tags innerhalb eines Kommentars. 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:XML-Dokumentationskommentar verwenden

/// <summary>
///  This is a hello world program.
/// </summary>

using System;

namespace HelloWorld
{
	class Program
	{
		public static void Main(string[] args)
		{
			Console.WriteLine("Hello World!");
		}
	}
}

Der im obigen Programm verwendete XML-Kommentar ist

/// <summary>
/// This is a hello world program.
/// </summary>

Die generierte XML-Dokumentation (.xml-Datei) enthält:

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

Besuchen Sie Kommentare zur XML-Dokumentation, wenn Sie mehr erfahren möchten.

---

Kommentare richtig verwenden

Kommentare werden verwendet, um Teile des Codes zu erklären, aber sie sollten nicht überstrapaziert werden.

Zum Beispiel:

// Prints Hello World
Console.WriteLine("Hello World");

Die Verwendung von Kommentaren im obigen Beispiel ist nicht erforderlich. Es ist offensichtlich, dass die Zeile Hello World drucken wird. 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 prägnant sein und keine lange Beschreibung.
• Als Faustregel gilt:Es ist besser zu erklären, warum statt wie , Kommentare verwenden.