I den här artikeln kommer vi att lära dig mer om C # -kommentarer, olika kommentarer och om varför och hur du använder dem i ett program.
Kommentarer används i ett program som hjälper oss att förstå en kod. De är mänskliga läsbara ord som är avsedda att göra koden läsbar. Kommentarer ignoreras helt av kompilatorn.
I C # finns det 3 typer av kommentarer:
- Enstaka kommentarer (
//) - Flerlinjekommentarer (
/* */) - XML-kommentarer (
///)
Kommentarer från en rad
Kommentarer på en rad börjar med ett dubbelt snedstreck //. Kompilatorn ignorerar allt efter //till slutet av raden. Till exempel,
int a = 5 + 7; // Lägga till 5 och 7
Här Adding 5 and 7är kommentaren.
Exempel 1: Använd en kommentar med en rad
// 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!"); ) ) )
Ovanstående program innehåller tre enradiga kommentarer:
// Hello World Program // Execution Starts from Main method
och
// Skriver ut Hello World
Kommentarer på en rad kan skrivas i en separat rad eller tillsammans med koderna i samma rad. Det rekommenderas dock att använda kommentarer i en separat rad.
Multi Line kommentarer
Kommentarer med flera rader börjar med /*och slutar med */. Kommentarer med flera rader kan sträcka sig över flera rader.
Exempel 2: Använda flera radkommentarer
/* 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!"); ) ) )
Ovanstående program innehåller två flerradiga kommentarer:
/ * Detta är ett Hello World-program i C #. Detta program skriver ut Hello World. * /
och
/ * Skriver ut Hello World * /
Här kanske vi har märkt att det inte är obligatoriskt för en kommentar med flera rader att sträcka sig över flera rader. /*… */kan användas istället för kommentarer på en rad.
XML-dokumentationskommentarer
XML-dokumentationskommentar är en speciell funktion i C #. Det börjar med en trippel snedstreck ///och används för att kategoriskt beskriva en kod kod … Detta görs med XML-taggar i en kommentar. Dessa kommentarer används sedan för att skapa en separat XML-dokumentationsfil.
Om du inte känner till XML, se Vad är XML?
Exempel 3: Använda 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 som används i ovanstående program är
/// /// Detta är ett hej världsprogram. ///
XML-dokumentationen (.xml-filen) som genereras innehåller:
Hej världen
Besök XML-dokumentationskommentarer om du är intresserad av att lära dig mer.
Använd kommentarer på rätt sätt
Kommentarer används för att förklara delar av koden men de bör inte överanvändas.
Till exempel:
// skriver Hello World Console.WriteLine ("Hello World");
Att använda kommentarer i exemplet ovan är inte nödvändigt. Det är uppenbart att linjen kommer att skriva ut Hello World. Kommentarer bör undvikas i sådana fall.
- Istället bör kommentarer användas i programmet för att förklara komplexa algoritmer och tekniker.
- Kommentarer ska vara korta och till punkt i stället för en lång beskrivning.
- Som en tumregel är det bättre att förklara varför istället för hur , med hjälp av kommentarer.
