In dit artikel zullen we leren over C # -commentaar, verschillende stijlen van reacties en waarom en hoe je ze in een programma kunt gebruiken.
Opmerkingen worden in een programma gebruikt om ons te helpen een stukje code te begrijpen. Het zijn door 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:
- Enkele regel opmerkingen (
//) - Opmerkingen over meerdere regels (
/* */) - XML-opmerkingen (
///)
Enkele regel opmerkingen
Opmerkingen met één regel beginnen met een dubbele schuine streep //. De compiler negeert alles na //het einde van de regel. Bijvoorbeeld,
int a = 5 + 7; // Toevoegen van 5 en 7
Hier Adding 5 and 7is de opmerking.
Voorbeeld 1: commentaar van éé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 enkele regel opmerkingen:
// Hello World-programma // Uitvoering start vanaf de hoofdmethode
en
// Prints Hallo wereld
Opmerkingen met één regel kunnen op een aparte regel worden geschreven of samen met de codes op dezelfde regel. Het wordt echter aanbevolen om opmerkingen op een aparte regel te gebruiken.
Opmerkingen over meerdere regels
Opmerkingen met meerdere regels beginnen met /*en eindigen met */. Opmerkingen met meerdere regels kunnen meerdere regels beslaan.
Voorbeeld 2: commentaar van 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 commentaren op meerdere regels:
/ * Dit is een Hello World-programma in C #. Dit programma drukt Hallo wereld af. * /
en
/ * Prints Hallo wereld * /
Hier hebben we misschien gemerkt dat het niet verplicht is dat een commentaar met meerdere regels zich over meerdere regels uitstrekt. /*… */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 commentaren worden vervolgens gebruikt om een apart XML-documentatiebestand te creëren.
Zie Wat is XML? Als u niet bekend bent met XML.
Voorbeeld 3: XML-documentatiecommentaar gebruiken
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
De XML-opmerking die in het bovenstaande programma wordt gebruikt, is
/// /// Dit is een hallo-wereldprogramma. ///
De gegenereerde XML-documentatie (.xml-bestand) bevat:
Hallo Wereld
Bezoek XML-documentatieopmerkingen als u 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:
// Drukt Hello World Console.WriteLine ("Hello World") af;
Het gebruik van commentaar in het bovenstaande voorbeeld is niet nodig. Het is duidelijk dat de regel Hallo wereld 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 opmerkingen.
