JAVA PAGRINDAI

Java komentarai

Komentarai padeda paaiškinti kodo paskirtį ir palengvina jo skaitymą. Java kompiliatorius komentarų nevykdo, todėl juose galima palikti žmogui skirtas pastabas arba laikinai išjungti bandomąją kodo eilutę.

Kam reikalingi komentarai?

Geras komentaras paaiškina priežastį, sprendimą arba neakivaizdžią programos taisyklę. Jis nėra Java komanda ir nekeičia programos rezultato. Komentarai ypač naudingi, kai prie to paties projekto dirba keli žmonės arba kai prie savo kodo grįžti po ilgesnio laiko.

  • paaiškinti sudėtingesnę kodo dalį;
  • užrašyti svarbią prielaidą ar sprendimo priežastį;
  • palikti trumpą pastabą kitam programuotojui;
  • laikinai išjungti kodo eilutę atliekant bandymą.

Vienos eilutės komentarai

Vienos eilutės komentaras pradedamas dviem pasviraisiais brūkšniais //. Java ignoruoja visą tekstą nuo šių ženklų iki eilutės pabaigos.

Komentarą galima parašyti atskiroje eilutėje prieš paaiškinamą kodą:

// Ši eilutė išveda pasisveikinimą
System.out.println("Labas, pasauli!");

Trumpą komentarą taip pat galima rašyti tos pačios kodo eilutės pabaigoje:

System.out.println("Labas, pasauli!"); // Išvedame tekstą
Rašyk glaustai

Eilutės pabaigos komentaras neturėtų paslėpti paties kodo. Jei paaiškinimas ilgesnis, perkelk jį į atskirą eilutę arba naudok komentarų bloką.

Kelių eilučių komentarai

Komentarų blokas pradedamas ženklais /* ir užbaigiamas ženklais */. Visas tarp jų esantis tekstas ignoruojamas, net jeigu jis užima kelias eilutes.

/* Toliau esanti komanda išves pasisveikinimą
   į programos konsolę. */
System.out.println("Labas, pasauli!");

Toks komentaras tinka ilgesniam paaiškinimui. Uždarymo ženklų */ pamiršti negalima – priešingu atveju kompiliatorius gali laikyti komentaru ir toliau esantį programos kodą arba parodyti klaidą.

Laikinas kodo išjungimas

Atliekant nedidelį bandymą komentaras gali laikinai neleisti vykdyti vienos eilutės. Toliau pateiktame pavyzdyje bus vykdoma tik pirmoji išvedimo komanda:

System.out.println("Pagrindinis variantas");
// System.out.println("Bandomasis variantas");

Ilgam palikti didelių nebevartojamo kodo blokų komentaruose nerekomenduojama. Versijų valdymo sistema gali išsaugoti ankstesnį kodą, o projekte lieka tik šiuo metu reikalinga versija.

Kurį komentaro tipą pasirinkti?

  • // naudok trumpai pastabai arba vienai eilutei paaiškinti.
  • /* ... */ naudok ilgesniam, kelias eilutes užimančiam paaiškinimui.
  • Komentuok tai, ko negalima aiškiai perteikti gerais kintamųjų, metodų ir klasių pavadinimais.
  • Pasikeitus kodui, patikrink, ar šalia esantis komentaras vis dar teisingas.