Comentarii în C#
Codul îl scrii o dată, dar îl citești de zeci de ori, tu sau colegii tăi. Comentariile sunt notițe în cod pe care compilatorul le ignoră complet. Le folosești ca să explici ce face codul și ca să dezactivezi temporar linii.
Comentariul pe o linie: //
Tot ce urmează după // până la finalul rândului este comentariu. Poate sta pe un rând separat sau la finalul unei instrucțiuni:
// Afișăm mesajul de bun venit
Console.WriteLine("Bun venit în magazin!");
Console.WriteLine("Reduceri azi: 20%"); // mesaj pentru campania de varăBun venit în magazin! Reduceri azi: 20%
Comentariile nu apar în consolă. Programul afișează doar ce scrie Console.WriteLine.
Scrie un program comentat care afișează două mesaje: Programul a pornit. și Programul s-a încheiat. Între ele, pune instrucțiunea Console.WriteLine("Mesaj de test"); dezactivată cu un comentariu, ca să nu apară în consolă.
- Adaugă la început un comentariu cu // care spune ce face programul.
- Afișează Programul a pornit.
- Scrie linia Console.WriteLine("Mesaj de test"); cu // în față.
- Afișează Programul s-a încheiat.
Soluția exercițiului
// Program care arată cum funcționează comentariile
Console.WriteLine("Programul a pornit.");
// Console.WriteLine("Mesaj de test");
Console.WriteLine("Programul s-a încheiat."); Vrei să afli mai mult?Comentariul pe mai multe linii: /* */ · Dezactivarea unei linii de cod · Comentariile XML: /// · Comentarii bune și comentarii inutile · Unde ajută comentariile
Comentariul pe mai multe linii: /* */
Pentru explicații mai lungi, pui textul între /* și */. Tot ce e între ele este ignorat, oricâte rânduri ar avea:
/*
Program: mesaje pentru clienți
Autor: echipa de vânzări
Ultima modificare: martie
*/
Console.WriteLine("Mulțumim pentru comandă!");Mulțumim pentru comandă!
Dezactivarea unei linii de cod
Un truc folosit zilnic: pui // în fața unei instrucțiuni ca să nu se mai execute, fără să o ștergi. Asta se numește „a comenta o linie”.
Console.WriteLine("Pasul 1: verificăm stocul");
// Console.WriteLine("Pasul 2: mesaj de test");
Console.WriteLine("Pasul 3: trimitem coletul");Pasul 1: verificăm stocul Pasul 3: trimitem coletul
Linia a doua nu s-a executat. Dacă ștergi //, ea revine în program.
În majoritatea editoarelor, scurtătura Ctrl + / (sau Cmd + / pe Mac) comentează sau decomentează linia curentă.
Comentariile XML: ///
În C# mai există un tip special: comentariile cu trei bare ///. Ele se pun deasupra metodelor și claselor și descriu ce fac. Editoarele precum Visual Studio le afișează ca ajutor când folosești metoda.
/// <summary>
/// Calculează prețul final al unui produs.
/// </summary>
static decimal PretFinal(decimal pret) { ... }Le vei folosi mai târziu, când scrii propriile metode. Deocamdată e suficient să le recunoști.
Comentarii bune și comentarii inutile
| Comentariu | Este util? |
|---|---|
| // adunăm 1 la contor | nu: spune exact ce se vede deja în cod |
| // clienții noi primesc 10% reducere | da: explică regula de business, adică „de ce” |
| // TODO: verifică stocul înainte de plată | da: o notiță pentru ce mai e de făcut |
- **Uiți să închizi /***: fără */, tot restul fișierului devine comentariu și apar erori ciudate.
- Comentarii învechite: dacă schimbi codul, actualizează și comentariul, altfel îi induci în eroare pe ceilalți.
Unde ajută comentariile
Colegii înțeleg rapid de ce ai ales o anumită soluție.
Dezactivezi linii pe rând ca să găsești sursa unei probleme.
Comentariile /// generează automat documentația unei biblioteci.
