C#-opmerkingen

In dit artikel leren we over C#-opmerkingen, verschillende stijlen van opmerkingen en waarom en hoe u ze in een programma kunt gebruiken.

Opmerkingen worden in een programma gebruikt om ons te helpen een stukje code te begrijpen. Het zijn voor mensen leesbare woorden die bedoeld zijn om de code leesbaar te maken. Opmerkingen worden volledig genegeerd door de compiler.

In C# zijn er 3 soorten opmerkingen:

1. Reacties van één regel ( // )
2. Opmerkingen met meerdere regels (/* */ )
3. XML-opmerkingen ( /// )

Eenregelige opmerkingen

Enkele regel opmerkingen beginnen met een dubbele schuine streep // . De compiler negeert alles na // naar het einde van de lijn. Bijvoorbeeld,

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

Hier, Adding 5 and 7 is de opmerking.

Voorbeeld 1:Opmerking met één regel gebruiken

// 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!");
		}
	}
}

Het bovenstaande programma bevat 3 opmerkingen van één regel:

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

en

// Prints Hello World

Enkele regel opmerkingen kunnen in een aparte regel of samen met de codes in dezelfde regel worden geschreven. Het wordt echter aanbevolen om opmerkingen in een aparte regel te gebruiken.

Opmerkingen met meerdere regels

Opmerkingen met meerdere regels beginnen met /* en eindigt met */ . Opmerkingen van meerdere regels kunnen meerdere regels beslaan.

Voorbeeld 2:commentaar met meerdere regels gebruiken

/*
	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!");
		}
	}
}

Het bovenstaande programma bevat 2 meerregelige opmerkingen:

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

en

/* Prints Hello World */

Hier hebben we misschien gemerkt dat het niet verplicht is dat een commentaar van meerdere regels meerdere regels omvat. /* … */ kan worden gebruikt in plaats van opmerkingen van één regel.

XML-documentatie opmerkingen

XML-documentatiecommentaar is een speciale functie in C#. Het begint met een drievoudige schuine streep /// en wordt gebruikt om een ​​stuk code categorisch te beschrijven. Dit wordt gedaan met behulp van XML-tags in een opmerking. Deze opmerkingen worden vervolgens gebruikt om een ​​apart XML-documentatiebestand te maken.

Als u niet bekend bent met XML, zie Wat is XML?

Voorbeeld 3:XML-documentatiecommentaar gebruiken

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

using System;

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

Het XML-commentaar dat in het bovenstaande programma wordt gebruikt, is

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

De gegenereerde XML-documentatie (.xml-bestand) bevat:

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

Bezoek XML Documentation Comments als je meer wilt weten.

Gebruik opmerkingen op de juiste manier

Opmerkingen worden gebruikt om delen van de code uit te leggen, maar ze mogen niet te veel worden gebruikt.

Bijvoorbeeld:

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

Het gebruik van commentaar in het bovenstaande voorbeeld is niet nodig. Het is duidelijk dat de regel Hello World zal afdrukken. In dergelijke gevallen moeten opmerkingen worden vermeden.

• In plaats daarvan moeten opmerkingen in het programma worden gebruikt om complexe algoritmen en technieken uit te leggen.
• Opmerkingen moeten kort en bondig zijn in plaats van een lange beschrijving.
• Als vuistregel is het beter om uit te leggen waarom in plaats van hoe , met behulp van opmerkingen.