C # Kommentarer: Hvordan bruke dem og hvorfor?

I denne artikkelen vil vi lære om C # kommentarer, annen kommentarstil, og hvorfor og hvordan du bruker dem i et program.

Kommentarer brukes i et program for å hjelpe oss med å forstå et stykke kode. De er lesbare ord som er ment å gjøre koden lesbar. Kommentarer ignoreres fullstendig av kompilatoren.

I C # er det 3 typer kommentarer:

  1. Enkel linje kommentarer ( //)
  2. Flere linjekommentarer ( /* */)
  3. XML-kommentarer ( ///)

Enkel linje kommentarer

Kommentarer fra en linje starter med en dobbel skråstrek //. Kompilatoren ignorerer alt etter //slutten av linjen. For eksempel,

int a = 5 + 7; // Legger til 5 og 7

Her Adding 5 and 7er kommentaren.

Eksempel 1: Bruke 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!"); ) ) )

Ovennevnte program inneholder 3 enkeltlinjekommentarer:

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

og

 // Skriver ut Hello World

Kommentarer fra en linje kan skrives i en egen linje eller sammen med kodene i samme linje. Det anbefales imidlertid å bruke kommentarer i en egen linje.

Flere linjekommentarer

Flere linjekommentarer starter med /*og slutter med */. Kommentarer med flere linjer kan strekke seg over flere linjer.

Eksempel 2: Bruke kommentar med flere linjer

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

Ovennevnte program inneholder to flerlinjekommentarer:

/ * Dette er et Hello World-program i C #. Dette programmet skriver ut Hello World. * /

og

 / * Skriver ut Hello World * /

Her har vi kanskje lagt merke til at det ikke er obligatorisk for en flerlinjekommentar å spenne over flere linjer. /*… */kan brukes i stedet for kommentarer på en linje.

XML-dokumentasjonskommentarer

XML-dokumentasjonskommentarer er en spesiell funksjon i C #. Det starter med en trippel skråstrek ///og brukes til å kategorisk beskrive et stykke kode … Dette gjøres ved hjelp av XML-koder i en kommentar. Disse kommentarene brukes deretter til å opprette en egen XML-dokumentasjonsfil.

Hvis du ikke er kjent med XML, kan du se Hva er XML?

Eksempel 3: Bruke XML-dokumentasjonskommentar

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

XML-kommentaren som brukes i programmet ovenfor er

/// /// Dette er et hei-verdensprogram. ///

XML-dokumentasjonen (.xml-filen) som genereres, vil inneholde:

 Hei Verden

Besøk XML-dokumentasjonskommentarer hvis du er interessert i å lære mer.

Bruk kommentarer på riktig måte

Kommentarer brukes til å forklare deler av koden, men de skal ikke brukes for mye.

For eksempel:

 // Skriver ut Hello World Console.WriteLine ("Hello World");

Det er ikke nødvendig å bruke kommentarer i eksemplet ovenfor. Det er åpenbart at linjen vil skrive ut Hello World. Kommentarer bør unngås i slike tilfeller.

  • I stedet bør kommentarer brukes i programmet for å 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 å forklare hvorfor i stedet for hvordan , ved hjelp av kommentarer.

Interessante artikler...