Šajā rakstā mēs uzzināsim par C # komentāriem, dažādu komentāru stilu un to, kāpēc un kā tos izmantot programmā.
Komentāri tiek izmantoti programmā, lai palīdzētu mums saprast koda fragmentu. Tie ir cilvēkiem lasāmi vārdi, kuru mērķis ir padarīt kodu salasāmu. Kompilators pilnībā ignorē komentārus.
C # ir trīs veidu komentāri:
- Vienrindas komentāri (
//) - Vairāku rindiņu komentāri (
/* */) - XML komentāri (
///)
Vienrindas komentāri
Vienrindas komentāri sākas ar dubultu slīpsvītru //. Sastādītājs ignorē visu pēc //rindas beigām. Piemēram,
int a = 5 + 7; // Pievienojot 5 un 7
Šeit Adding 5 and 7ir komentārs.
1. piemērs: vienas rindas komentāra izmantošana
// 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!"); ) ) )
Iepriekš minētajā programmā ir 3 vienas rindas komentāri:
// Hello World programma // Izpilde sākas no galvenās metodes
un
// Izdrukā Sveika pasaule
Atsevišķas rindas komentārus var rakstīt atsevišķā rindā vai kopā ar kodiem vienā rindā. Tomēr komentārus ieteicams izmantot atsevišķā rindā.
Vairāku rindiņu komentāri
Vairāku rindiņu komentāri sākas ar /*un beidzas ar */. Vairāku rindiņu komentāri var ietvert vairākas rindas.
2. piemērs: vairāku rindiņu komentāru izmantošana
/* 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!"); ) ) )
Iepriekš minētajā programmā ir 2 vairāku rindiņu komentāri:
/ * Šī ir Hello World programma C #. Šī programma izdrukā Hello World. * /
un
/ * Izdrukā Hello World * /
Šeit mēs, iespējams, pamanījām, ka vairāku rindiņu komentāri nav obligāti jāaptver vairākās rindās. /*… */var izmantot vienas rindas komentāru vietā.
XML dokumentācijas komentāri
XML dokumentācijas komentārs ir īpaša iezīme C #. Tas sākas ar trīskāršu slīpsvītru ///un tiek izmantots, lai kategoriski aprakstītu koda fragmentu … Tas tiek darīts, komentārā izmantojot XML tagus. Pēc tam šie komentāri tiek izmantoti, lai izveidotu atsevišķu XML dokumentācijas failu.
Ja jums nav zināms XML, skatiet rakstu Kas ir XML?
3. piemērs: XML dokumentācijas komentāra izmantošana
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Iepriekš minētajā programmā izmantotais XML komentārs ir
/// /// Šī ir sveika pasaules programma. ///
Izveidotajā XML dokumentācijā (.xml failā) būs:
Sveika pasaule
Apmeklējiet XML dokumentācijas komentārus, ja vēlaties uzzināt vairāk.
Izmantojiet komentārus pareizi
Komentāri tiek izmantoti, lai izskaidrotu koda daļas, taču tos nevajadzētu pārmērīgi izmantot.
Piemēram:
// Drukā Hello World Console.WriteLine ("Hello World");
Komentāra izmantošana iepriekš minētajā piemērā nav nepieciešama. Ir acīmredzams, ka līnija drukās Hello World. Šādos gadījumos jāizvairās no komentāriem.
- Tā vietā, lai izskaidrotu sarežģītus algoritmus un paņēmienus, programmā jāizmanto komentāri.
- Komentāriem jābūt īsiem un precīziem, nevis garam aprakstam.
- Pēc īkšķa principa labāk ir paskaidrot, kāpēc, nevis kā , izmantojot komentārus.
