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ă (retard). Dar cum? Mult mai simplu, lejer și plăcut…

Î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ă e 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…

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 cu simbolurile */ (asterisc și slash).

Exemple:

• System.out.println(“Salutare, lume”); // Acesta este un comentariu simplu
• int numarPar = 100; // Important la metoda alfaSiBeta()
• /*
  Metodă cu rol de testare…
  De făcut o altă metodă care să preia valorile impare și să le verifice dacă sunt din șirul lui Fibonacci
  Ultima testare: 12.01.2023
  */
  (Aceast tip de comentariu este specific pentru explicații mai amănunțite și te ajută pe tine, ca programator, ca data viitoare când revii, să știi ce ai făcut înainte și care sunt pașii următori… Practic, tu te ajuți pe tine, dar și pe ceilalți colegi ca să se înțeleagă ce ai vrut să faci la momentul respectiv, la ce pas te-ai aflat sau încă te afli.)

Este evident faptul că unele comentarii vor dispărea pe parcurs, în special cele care se întind pe mai multe linii. Sau poate că nu vor dispărea, dar vor fi actualizate. 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șare a 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, nu se va lua în calcul de către compilator.

Exemplul 1:

1| int numarPar = 100;
2| /*
3| System.out.println("Numarul par este: " + numarPar);
4| */
5| System.out.println("Salutare!"); // numarPar = 102;
6| System.out.prinln("Numarul par este: " + numarPar);  

Ce crezi că va afișa programul anterior? Pe rândul 1 ai o definire a variabilei numarPar, apoi pe rândurile de la 2 la 4 ai un comentariu (deci nu se va afișa textul…), pe rândul 5 ai o afișare (te salută, dar să fii atent că variabila numarPar nu-și va schimba valoarea, fiindcă atribuirea se află într-un comentariu, deci nu are niciun efect), iar pe rândul 6 se va afișa mesajul „Numărul par este: 100”.

Exemplul 2:

1|/* System.out.println("Salutare!");
2| System.out.println("Ce mai faci?");*/
3| 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 /* ș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 e? Sau poți să folosești mai multe semne asterisc, chiar pe fiecare rând…

/**
* 1
* 2
* 3
*/

Exemplu:

 1| /**
 2| *< h 1 > Titlu < / h 1 >
 3| * Acest program 
 4| * are un rol aparte. 
 5| * Te rog să-i acorzi 
 6| * o atenție sporită! 
 7| * Mulțumesc! 
 8| * 
 9| * @autor: projava.ro 
10| * @versiune: 1.0.2 
11| * @data 12.01.2023 
12| */

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… Învață să folosești comentariile de tipul // și /*…*/. E suficient, momentan.

Învață să fii profesionist!

Sursă imagine: Bastian Riccardi on Unsplash