În acest articol, vom afla despre comentariile C #, stilul diferit de comentarii și de ce și cum să le folosim într-un program.
Comentariile sunt utilizate într-un program pentru a ne ajuta să înțelegem o bucată de cod. Sunt cuvinte care pot fi citite de oameni, destinate să facă codul lizibil. Comentariile sunt complet ignorate de compilator.
În C #, există 3 tipuri de comentarii:
- Comentarii cu o singură linie (
//) - Comentarii pe mai multe linii (
/* */) - Comentarii XML (
///)
Comentarii cu o singură linie
Comentariile cu o singură linie încep cu o bară dublă //. Compilatorul ignoră totul //până la sfârșitul liniei. De exemplu,
int a = 5 + 7; // Adăugarea 5 și 7
Iată Adding 5 and 7comentariul.
Exemplul 1: Utilizarea comentariului cu o singură linie
// 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!"); ) ) )
Programul de mai sus conține 3 comentarii cu o singură linie:
// Programul Hello World // Executarea începe de la metoda principală
și
// Tipărește Hello World
Comentariile cu o singură linie pot fi scrise într-o linie separată sau împreună cu codurile din aceeași linie. Cu toate acestea, se recomandă utilizarea comentariilor într-o linie separată.
Comentarii pe mai multe linii
Comentariile pe mai multe linii încep cu /*și se termină cu */. Comentariile pe mai multe linii se pot întinde pe mai multe linii.
Exemplul 2: utilizarea comentariului pe mai multe linii
/* 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!"); ) ) )
Programul de mai sus conține 2 comentarii cu mai multe linii:
/ * Acesta este un program Hello World în C #. Acest program tipărește Hello World. * /
și
/ * Tipărește Hello World * /
Aici este posibil să fi observat că nu este obligatoriu ca un comentariu cu mai multe linii să se întindă pe mai multe linii. /*… */poate fi folosit în locul comentariilor cu o singură linie.
Comentarii despre documentația XML
Comentariul de documentare XML este o caracteristică specială în C #. Începe cu o bară triplă ///și este utilizată pentru a descrie categoric o bucată de cod … Acest lucru se face folosind etichete XML într-un comentariu. Aceste comentarii sunt apoi utilizate pentru a crea un fișier de documentare XML separat.
Dacă nu sunteți familiarizat cu XML, consultați Ce este XML?
Exemplul 3: Utilizarea comentariului documentației XML
/// /// This is a hello world program. /// using System; namespace HelloWorld ( class Program ( public static void Main(string() args) ( Console.WriteLine("Hello World!"); ) ) )
Comentariul XML utilizat în programul de mai sus este
/// /// Acesta este un program Hello World. ///
Documentația XML (fișierul .xml) generată va conține:
Salut Lume
Accesați comentarii despre documentația XML dacă sunteți interesat să aflați mai multe.
Utilizați comentariile în modul corect
Comentariile sunt utilizate pentru a explica părți ale codului, dar nu ar trebui să fie utilizate în exces.
De exemplu:
// Printează Hello World Console.WriteLine („Hello World”);
Utilizarea comentariului în exemplul de mai sus nu este necesară. Este evident că linia va imprima Hello World. Comentariile ar trebui evitate în astfel de cazuri.
- În schimb, comentariile ar trebui utilizate în program pentru a explica algoritmi și tehnici complexe.
- Comentariile trebuie să fie scurte și la obiect, în loc de o descriere lungă.
- De regulă, este mai bine să explicăm de ce, în loc de cum , folosind comentarii.
