C # Kommentarer: Hvordan man bruger dem og hvorfor?

I denne artikel lærer vi om C # -kommentarer, forskellige kommentarerstil, og hvorfor og hvordan man bruger dem i et program.

Kommentarer bruges i et program til at hjælpe os med at forstå et stykke kode. De er menneskelige læsbare ord beregnet til at gøre koden læsbar. Kommentarer ignoreres fuldstændigt af kompilatoren.

I C # er der 3 typer kommentarer:

  1. Kommentarer til en enkelt linje ( //)
  2. Kommentarer til flere linjer ( /* */)
  3. XML-kommentarer ( ///)

Kommentarer til en enkelt linje

Kommentarer fra en enkelt linje starter med et dobbelt skråstreg //. Compileren ignorerer alt efter //til slutningen af ​​linjen. For eksempel,

int a = 5 + 7; // Tilføjelse af 5 og 7

Her Adding 5 and 7er kommentaren.

Eksempel 1: Brug af en linjekommentar

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

Ovenstående program indeholder 3 enkeltlinjekommentarer:

 // Hej verdensprogram // Udførelse starter fra hovedmetoden

og

 // udskriver Hello World

Kommentarer til en enkelt linje kan skrives i en separat linje eller sammen med koderne i samme linje. Det anbefales dog at bruge kommentarer i en separat linje.

Multi Line kommentarer

Flere linjekommentarer starter med /*og slutter med */. Kommentarer med flere linjer kan spænde over flere linjer.

Eksempel 2: Brug af flere linjekommentarer

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

Ovenstående program indeholder 2 flerlinjekommentarer:

/ * Dette er et Hello World-program i C #. Dette program udskriver Hello World. * /

og

 / * Udskriver Hello World * /

Her har vi måske bemærket, at det ikke er obligatorisk for en flerlinjekommentar at strække sig over flere linjer. /*… */kan bruges i stedet for kommentarer til en linje.

XML-dokumentationskommentarer

XML-dokumentationskommentar er en speciel funktion i C #. Det starter med et tredobbelt skråstreg ///og bruges til kategorisk at beskrive et stykke kode … Dette gøres ved hjælp af XML-tags i en kommentar. Disse kommentarer bruges derefter til at oprette en separat XML-dokumentationsfil.

Hvis du ikke er fortrolig med XML, skal du se Hvad er XML?

Eksempel 3: Brug af XML-dokumentationskommentar

 /// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )

XML-kommentaren, der er brugt i ovenstående program, er

/// /// Dette er et hej verdensprogram. ///

Den genererede XML-dokumentation (.xml-fil) indeholder:

 Hej Verden

Besøg XML-dokumentationskommentarer, hvis du er interesseret i at lære mere.

Brug kommentarer på den rigtige måde

Kommentarer bruges til at forklare dele af koden, men de bør ikke bruges for meget.

For eksempel:

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

Brug af kommentar i eksemplet ovenfor er ikke nødvendigt. Det er indlysende, at linjen vil udskrive Hello World. Kommentarer bør undgås i sådanne tilfælde.

  • I stedet skal kommentarer bruges i programmet til at forklare komplekse algoritmer og teknikker.
  • Kommentarer skal være korte og til punktet i stedet for en lang beskrivelse.
  • Som en tommelfingerregel er det bedre at forklare hvorfor i stedet for hvordan ved hjælp af kommentarer.

Interessante artikler...