Kas yra Java ko­men­ta­rai ir kaip juos kurti

Java yra trys skirtingi komentarų tipai. Ko­men­ta­rus galite naudoti kodui struk­tū­ri­zuo­ti ir pa­aiš­kin­ti. Vienos eilutės ko­men­ta­rai skirti trumpoms pastaboms, o blokiniai ko­men­ta­rai tinka il­ges­niems pa­aiš­ki­ni­mams. Kita vertus, do­ku­men­ta­ci­jos ko­men­ta­rai yra išsamūs ir suteikia pridėtinę vertę, vir­ši­jan­čią šaltinio kodą.

Kas yra Java ko­men­ta­rai?

Darbas su šaltinio kodu kartais gali kelti problemų net ir pa­ty­ru­siems prog­ra­muo­to­jams. Pri­klau­so­mai nuo projekto ir jo apimties, situacija gali greitai tapti ne­nu­spė­ja­ma, o kodas – painus. Tokiais atvejais galbūt ne­no­rė­si­te dirbti su kodu vieni. Tačiau net jei norėsite, kad kiti galėtų su­si­pa­žin­ti su jūsų kodu, jie gali ne­su­ge­bė­ti jo in­tui­ty­viai suprasti.

Siekiant išvengti ne­su­si­pra­t­imų ir aiškiau struk­tū­ri­zuo­ti kodą, Java suteikia var­to­to­jams galimybę rašyti ko­men­ta­rus. Šioje prog­ra­ma­vi­mo kalboje ko­men­ta­rus galite naudoti savo mąstymo procesui, skai­čia­vi­mams, metodams, klasėms ar struk­tū­roms pa­aiš­kin­ti. Kai jūs ar kas nors kitas vėliau žiūrėsite kodą, ko­men­ta­rai pa­leng­vins darbą su kodu.

Kad ko­men­ta­rai būtų veiks­min­gi, svarbu, kad jie būtų kuo trumpesni. Tuo pačiu metu jie turėtų suteikti skai­ty­to­jams pa­kan­ka­mai in­for­ma­ci­jos. Spren­džiant problemas, labai svarbu, kad ko­men­ta­rai būtų gerai su­for­mu­luo­ti.

Java ko­men­ta­rai yra trijų skirtingų tipų: vienos eilutės ko­men­ta­rai, blokiniai ko­men­ta­rai (dau­gi­a­reikš­miai ko­men­ta­rai) ir do­ku­men­ta­ci­jos ko­men­ta­rai. Visi ko­men­ta­rai yra pažymėti, todėl jie nėra įtrau­kia­mi į kom­pi­lia­ci­ją. Toliau pa­teik­tuo­se skyriuose pa­ro­dy­si­me, kaip kurti Java ko­men­ta­rus ir kada naudoti kiekvieną iš jų.

Kokios yra komentarų rūšys Java kalboje?

Pri­klau­so­mai nuo in­for­ma­ci­jos, kurią norite įrašyti, Java kalboje yra trys skirtingi komentarų tipai. Tai yra:

Vienos eilutės ko­men­ta­rai

Tai pa­pras­čiau­sias komentarų variantas. Šio tipo ko­men­ta­rai kuriamos naudojant du iš eilės einančius kir­ti­klius (//) ir negali būti ilgesni nei viena eilutė. Vienos eilutės ko­men­ta­ruo­se nereikia nurodyti pabaigos taško, nes jis au­to­ma­tiš­kai pa­sie­kia­mas eilutės pabaigoje. Šio tipo Java ko­men­ta­rai tinka trumpiems ko­men­ta­rams, kurie keliais žodžiais paaiškina funkciją.

Dau­gi­a­reikš­mės pastabos

Jei jūsų pa­aiš­ki­ni­mai turi būti šiek tiek ilgesni, galite naudoti kelių eilučių ko­men­ta­rus. Teoriškai jie gali būti bet kokio ilgio. Jie tinka įtraukti al­ter­na­ty­vias kodų eilutes, kurios yra išskirtos iš kom­pi­lia­ci­jos, arba išsamiems pa­aiš­ki­ni­mams. Dau­gi­a­reikš­mės pastabos pra­de­da­mos įstrižine ir žvaigž­du­te (/*). Pasiekus pastabos pabaigą, reikia įvesti žvaigž­du­tę, po kurios eina įstrižinė (*/). Tekstas tarp įvadinės įstri­ži­nės ir uždarymo įstri­ži­nės laikomas pastaba ir nėra įtrau­kia­mas į kodo kom­pi­lia­ci­ją.

Do­ku­men­ta­ci­jos ko­men­ta­rai

Nors vienos eilutės ir kelių eilučių ko­men­ta­rai teoriškai gali būti įterpiami bet kurioje šaltinio kodo vietoje, do­ku­men­ta­ci­jos ko­men­ta­rai visada rašomi tiesiai prieš klases ar metodus, kuriuos jie apibūdina. Naudojant įrankius, šie ko­men­ta­rai yra nu­skai­to­mi ir api­bend­ri­na­mi HTML do­ku­men­ta­ci­jo­je. Jie dau­giau­sia naudojami me­ta­duo­me­nims autoriams ir tam tikrų tipų pa­ra­met­rams kurti. Jie pažymėti simboliu @. Do­ku­men­ta­ci­jos ko­men­ta­rai pradedami brūkšniu ir dviem žvaigž­du­tė­mis (/**), o baigiami žvaigž­du­te ir brūkšniu (*/).

Vienos eilutės ko­men­ta­rai

Norėdami suprasti, kaip Java ko­men­ta­rai veikia prak­ti­ko­je, pa­žiū­rė­si­me keletą paprastų pavyzdžių. Juos galite išbandyti patys, kad pa­tik­rin­tu­mė­te rezultatą. Vienos eilutės ko­men­ta­ras prasideda dviem brūkšne­liais ir gali būti rašomas atskiroje eilutėje arba po inst­ruk­ci­jų rinkinio. **. Štai kaip ko­men­ta­ras atrodo atskiroje eilutėje:

// Example of a single-line comment
class Main {
	public static void main(String[] args) {
	// Here is the comment
	System.out.println("This is the text that will be output at the end.");
	}
}

Jei naudojate Java komandą System.out.println, bus rodomas tik sakinys „Tai yra tekstas, kuris išvedamas pabaigoje“. Du ko­men­ta­rai bus rodomi tik šaltinio kode.

Arba komentarą galite įrašyti tiesiai po komandos:

// Example of a single-line comment
class Main {
public static void main(String[] args) {
System.out.println("This is the text that is output at the end."); // This is the comment.
	}
}

Komentarų iš­dės­ty­mas nekeičia išvesties.

Dau­gi­a­reikš­mės pastabos

Jei norite įterpti kelių eilučių komentarą į savo kodą, galite jį įtraukti prieš arba po inst­ruk­ci­jų savo kode. Kelių eilučių ko­men­ta­rai visada pradedami kirtikliu ir žvaigž­du­te. Čia pa­tei­kia­mas kelių eilučių ko­men­ta­ras prieš kodo inst­ruk­ci­jas:

/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are under the comment.
This is the last line of this Java comment.
*/
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
	}
}

Išvestis rodo „Tai yra tekstas, kuris bus išvestas pabaigoje.“.

Štai kaip įterpti komentarą po inst­ruk­ci­jo­mis:

// Example of a multi-line comment below the instructions
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are above the comment.
This is the last line of this Java comment. */
	}
}

Re­zul­ta­tas turėtų būti toks pat kaip ir anks­tes­nia­me pavyzdyje. Vienos eilutės ko­men­ta­ras pirmoje kodo fragmentų eilutėje taip pat nebus rodomas. Žvaigž­du­tę ir kirtiklį galite įrašyti tiesiai po komentaro arba naudoti atskirą eilutę.

Do­ku­men­ta­ci­jos ko­men­ta­rai

Do­ku­men­ta­ci­jos ko­men­ta­rai veikia panašiai kaip blokiniai ko­men­ta­rai, tačiau yra žymimi kirtikliu ir dviem žvaigž­du­tė­mis. Tai leidžia do­ku­men­ta­ci­jos įrankiams naudoti ko­men­ta­rus do­ku­men­ta­ci­jai kurti. Prireikus jie taip pat gali turėti HTML žymes, pvz., <h1>, <p> arba <strong>.

Javadoc, po­pu­lia­rus įrankis, kurį galite naudoti do­ku­men­ta­ci­jos ko­men­ta­rams skaityti, taip pat naudoja kitas naudingas žymes. Štai keletas svar­biau­sių iš jų:

939263ef5a1ac120c2d75264caf221db

7b0ed9d2883272aca77983e730a08231

e8793b7420ec40a292e7f68d6407a5d9