Cum se face un comentariu în Java? Un lucru e cert: nu prin suduire sau printr-un comportament obraznic presărat cu vulgaritate și incompetență emoțională. Dar cum? Mult mai simplu, lejer și plăcut, cu ajutorul unor simboluri.

În orice limbaj de programare există noțiunea de „comentariu”. Ce faci cu ajutorul unui comentariu? Pur și simplu explici o parte din program atunci când consideri că este nevoie.

Un beneficiu al comentariilor este și acela de a lăsa indicii cu privire la codul pe care l-ai scris celor care vor continua să scrie cod sau care vor aduce îmbunătățiri la programul tău. Sau poate fi un beneficiu chiar și pentru tine, dacă ești mai uituc și nu mai ții minte ce ai vrut să faci.

Trebuie să ții cont de un aspect foarte important în meseria de programator: nu ești singur! Ce înseamnă asta? Nu ești singurul care lucrează la o aplicație de tip Facebook, Tweeter, Netflix, YouTube sau Google. Ai zeci, sute sau chiar mii de colegi. Fiecare știe ce are de făcut, dar ca treaba să funcționeze ceas, trebuie să mai lași pe-alocuri și niște comentarii cu rol explicativ.

Bineînțeles că nu trebuie să faci abuz și nu merită să pui comentarii la fiecare linie de cod. Codul trebuie să fie cât mai intuitiv posibil, dar în caz că faci niște „artificii”, atunci este recomandat să lași niște comentarii.

Sunt 2 tipuri de comentarii în Java:

1. Comentariu pe o singură linie (single-line comment): se folosesc simbolurile // (dublu slash), astfel că tot ce se scrie după aceste simboluri va fi ignorat la compilare și doar cine are acces la codul sursă (programul în sine) va vedea comentariul, care trebuie să aibă un rol ajutător.
2. Comentariu pe mai multe linii (multi-line comment sau block comment): se folosesc simbolurile /* și */. Deci se începe cu simbolurile /* (slash și asterisc), apoi se scrie o explicație ce se poate întinde pe mai multe rânduri, iar la final se încheie comentariul folosind simbolurile */ (asterisc și slash).

Exemple:

 
System.out.println("Salutare, lume!");
// comentariu simplu, pe un singur rând
int numarPar = 100; // numarPar
/*
Acesta este un comentariu pe mai multe linii.
Trebuie să creez articole profesionale
pentru limbajul Java
ca să-ți fie mai ușor să înveți
la un nivel de profesionist!
Ultima testare: 12.01.2023
*/

Este posibil ca unele comentarii să fie modificate pe parcurs, în special cele care se întind pe mai multe linii. De exemplu, pe vremuri (dar încă se mai practică), la început de program, se scria un comentariu pe mai multe linii în care se trecea data, autorul și cerința programului.

 
/*
Autor: projava.ro
Data: 12.01.2023
Cerință: algoritm de sortare
a numerelor impare 
și afișarea numerelor
din șirul lui Fibonacci
*/

Trebuie să ții minte faptul că orice cod ai scrie, fie la comentariul pentru o singură linie, fie la comentariile pe mai multe linii, textul introdus după sau între simbolurile respective, nu se va lua în calcul de către compilator.

Hai să vedem câteva exemple de comentarii în Java.

Exemple de comentarii în Java 🔗

Pornim cu exemple ușoare și logice, pas cu pas. Este bine să înveți chestii noi și apoi să îți iei un pic de timp ca să le înțelegi. Nu merită să treci mai departe la alte concepte dacă nu înțelegi lucrurile de bază! Orice limbaj de programare are conceptul de comentariu, deci este ceva elementar care trebuie înțeles.

 
int numarImpar = 99;
/*
System.out.println("Numarul impar este: " + numarImpar);
*/
// int numarPar = 100;
System.out.println("Numarul par este: " + numarPar);

Ce crezi că va afișa programul anterior? Pe rândul 1 avem o definire a variabilei numarPar, apoi pe rândurile de la 2 la 4 avem un comentariu pe mai multe linii (deci nu se va afișa acel text). Pe rândul 5 avem o declarare a unei variabile, numai că se află într-un comentariu, deci nu se ia în calcul. Din ultimul rând va rezulta o eroare pentru că variabila numarPar nu este definită. Ce zici? E totul logic, nu-i așa?

Uite un alt exemplu mai simplu:

 
/* System.out.println("Salutare!");
System.out.println("Ce mai faci?"); */
System.out.println("Afișează o singură linie de cod"); // Adevărat!

Programul anterior afișează doar rândul 3. De ce? Pentru că primele două rânduri sunt incluse între simbolurile /* și */. N-am mai stat să indentez codul, ci pur și simplu am pus simbolurile „strategic”.

În plus, pe lângă cele două tipuri de comentarii (// și /*…*/), există un al treilea tip mai special, folosit pentru documentație. Îl vei întâlni doar la programele de dimensiuni foarte mari sau la programe de standardizare cu scopul de a crea fișiere .html pentru API. Aceste API-uri au nevoie de anumite referințe, astfel că se pun tot felul de taguri pentru @clasă, @metodă, @argument etc.

Pentru a crea astfel de documente cu ajutorul acestui tip de comentarii, trebuie doar să introduci un semn în plus de astersic în antet.

 
/**
.
.
.
*/

Vezi ce simplu este? De asemenea, poți să folosești mai multe semne asterisc, chiar pe fiecare rând…

 
/**
* 1
* 2
* 3
*/

Exemplu cu mai multe asteriscuri (comentariu pentru documentații):

 
/**
* <h1>Titlu</h1>;
* Acest program 
* are un rol aparte.
* Te rog să-i acorzi
* o atenție sporită!
* Mulțumesc!
*
* @autor: projava.ro
* @versiune: 1.0.2
* @data: 12.01.2023
*/

Fii pe pace! Pentru a mânui acest tip de comentariu ai nevoie de ceva experiență și nu te va pune nimeni la început (sper) să menții o astfel de documentație.

Momentan, este suficient să știi cum să folosești comentariile de tipul // și /*…*/.

Învață să fii profesionist!