Comentarii în C++

Există momente, în special în cazul codurilor lungi, când vrem să lăsăm mesaje prin cod pentru a explica ce fac anumite secvențe, aceste mesaje neinfluențând cu nimic codul.

Putem face asta cu ușurință în C++ cu ajutorul comentariilor.

Comentarii pe o linie

Primul tip de comentarii (și cel mai des utilizat) este comentariul de pe o singură linie.

Sintaxă

//Comentariu

sau

instrucțiune; //Comentariu de după instrucțiune

Pentru a scrie un comentariu de acest tip, scriem // (două slash-uri normale), urmate de mesajul nostru, care poate avea orice lungime. Orice scriem aici — cuvinte, sau chiar cod — nu va fi luat în considerare când rulăm programul nostru. Observăm că putem să punem un comentariu chiar după o instrucțiune.

Exemple

Un mesaj explicativ. După instrucțiunea cin >> n;, explicăm ce face. Liniile de după (cea cu instrucțiunea cout) se rulează, deoarece nu fac parte din comentariu.

int n;
cin >> n; //Citim de la tastatură o valoare pentru n
cout << "Am citit: " << n << "\n";

Ștergerea unei linii de cod. Punând // în fața instrucțiunii n++;, o transformăm în comentariu, aceasta nemaifiind rulată. Astfel, n nu mai crește cu 1:

int n;
cin >> n;
if(n % 2 == 0) {
    //n++;
    cout << n << " este par\n";
}

Recomandare pentru Code::Blocks

În Code::Blocks putem observa comentariile ușor, deoarece sunt gri. Cu toate acestea, nuanța de gri este foarte deschisă, astfel că este destul de greu să citim ce scrie. Așadar, putem să adăugăm un / în plus (adică ///), comentariul schimbându-și culoarea într-una mai vizibilă:

///Comentariu mai vizibil

Acest tip de comentariu poartă numele de comentariu de documentație, însă pentru compilator are aceeași semnificație cu un comentariu obișnuit.

Comentarii de tip bloc

Există o limitare cu tipul anterior de comentarii: să zicem că vrem să comentăm mai multe linii consecutive ale unui cod. Pentru asta, ne putem folosi de comentariul de tip bloc.

Sintaxă

/*Aici putem să scriem
orice vrem
pe oricâte linii
         vrem!*/

Practic, între două delimitatoare (/* și */) putem să scriem orice fără a fi luat în considerare.

Exemple

Comentariile de tip bloc pot fi și pe o singură linie. Nu este foarte practic (având primul tip de comentariu ca alternativă mai ușoară). Iată un exemplu:

int n;
cin >> n; /*Citim de la tastatură o valoare pentru n*/
cout << "Am citit: " << n << "\n";

Comentarea unei secvențe de cod. Pentru a scoate temporar o secvență de cod, putem proceda astfel:

int n;
cin >> n;
/*if(n % 2 == 0) {
    cout << n << " este par\n";
}*/
if(n % 3 == 0) {
    cout << n << " este divizibil cu 3\n";
}

Recomandare pentru Code::Blocks

În Code::Blocks putem observa comentariile ușor, deoarece sunt gri. Cu toate acestea, nuanța de gri este foarte deschisă, astfel că este destul de greu să citim ce scrie. Așadar, putem să adăugăm un * în plus la începutul comentariului (adică /**), comentariul schimbându-și culoarea într-una mai vizibilă:

/**Comentariu mai vizibil
*/

Acest tip de comentariu poartă numele de comentariu de documentație, însă pentru compilator are aceeași semnificație cu un comentariu obișnuit.

Utilitatea comentariilor

Comentariile în cod sunt foarte utile dintr-o mare varietate de motive:

• Poți lăsa mesaje explicative despre secvențe de cod (sau despre tot codul), pentru a fi mai ușor altcuiva (sau chiar ție) să înțelegi codul;
• Poți lăsa mesaje cu lucruri de făcut (un todo list);
• Poți scoate temporar părți din cod pentru a vedea comportamentul codului (și pentru a înțelege ce face);
• Și nu numai.

Bibliografie sau alte resurse

• InfoGenius
• PbInfo