Mis on Java kom­men­taa­rid ja kuidas neid luua?

Java-s on kolm erinevat tüüpi kom­men­taare. Kom­men­taare saab kasutada koodi struk­tu­ree­ri­miseks ja sel­gi­ta­miseks. Ühe­rea­li­sed kom­men­taa­rid on mõeldud lühikeste märkuste jaoks, blo­ki­kom­men­taa­rid sobivad pikemate sel­gi­tuste jaoks. Do­ku­men­tat­sioo­ni­kom­men­taa­rid on aga ula­tus­li­kud ja pakuvad li­sa­väär­tust, mis ületab al­li­ka­koodi.

Mis on Java kom­men­taa­rid?

Al­li­ka­koo­diga töötamine võib mõnikord tekitada probleeme isegi kogenud aren­da­ja­tele. Sõltuvalt pro­jek­tist ja selle ulatusest võivad asjad kiiresti muutuda et­te­ar­va­ma­tuks ja kood võib muutuda se­ga­dus­seaja­vaks. Sellistel hetkedel ei pruugi te tahta oma koodiga üksi töötada. Kuid isegi kui soovite, et teised saaksid teie koodile juurde pääseda, ei pruugi nad seda in­tui­tiiv­selt mõista.

Et vältida aru­saa­ma­tusi ja muuta kood selgemaks, võimaldab Java ka­su­ta­ja­tel kirjutada kom­men­taare. Selles prog­ram­mee­ri­mis­kee­les saate kom­men­taa­ride abil selgitada oma mõt­te­käiku, arvutusi, meetodeid, klasse või struk­tuure. Kui teie või keegi teine vaatab koodi hiljem, muudavad kom­men­taa­rid koodiga töötamise liht­sa­maks.

Kom­men­taa­ride tõhususe ta­ga­miseks on oluline, et need oleksid või­ma­li­kult lühikesed. Samal ajal peaksid need pakkuma lu­ge­ja­tele piisavalt teavet. Prob­leemide la­hen­da­misel on hästi sõ­nas­ta­tud kom­men­taa­rid hä­da­va­ja­li­kud.

Java kom­men­taa­rid on saadaval kolmes erinevas ver­sioo­nis: ühe­rea­li­sed kom­men­taa­rid, plokk­kom­men­taa­rid (mit­me­rea­li­sed kom­men­taa­rid) ja do­ku­men­tat­sioo­ni­kom­men­taa­rid. Kõik kom­men­taa­rid on mär­gis­ta­tud, et neid kom­pi­lee­ri­misel arvesse ei võetaks. Järg­mis­tes jaotistes näitame, kuidas Java kom­men­taare luua ja millal neid kasutada.

Milliseid kom­men­taare on Java-s?

Sõltuvalt sellest, millist teavet soovite kirjutada, on Java-s saadaval kolm erinevat tüüpi kom­men­taari. Need on:

Ühe­rea­li­sed kom­men­taa­rid

See on lihtsaim kom­men­taa­ri­või­ma­lus. Selline kom­men­taar luuakse kahe jär­jes­ti­kuse kald­kriip­suga (//) ja see ei tohi olla pikem kui üks rida. Ühe­realiste kom­men­taa­ride puhul ei ole vaja lõpp-punkti märkida, kuna see saa­vu­ta­takse au­to­maat­selt rea lõpus. Sellised Java-kom­men­taa­rid sobivad lühikeste kom­men­taa­ride jaoks, mis sel­gi­ta­vad funkt­siooni paar sõnaga.

Mit­me­rea­li­sed kom­men­taa­rid

Kui teie sel­gi­tu­sed peavad olema veidi pikemad, võite kasutada mit­me­rea­lisi kom­men­taare. Teo­ree­ti­li­selt võivad need olla mis tahes pikkusega. Need sobivad kom­pi­lee­ri­mi­sest välja jäetud al­ter­na­tiiv­sete koo­di­ri­dade li­sa­miseks või ük­sik­as­ja­like sel­gi­tuste jaoks. Mit­me­rea­li­sed kom­men­taa­rid algavad kald­kriip­suga ja tärniga (/*). Kom­men­taari lõppu jõudes tuleb lihtsalt kirjutada tärn, millele järgneb kald­kriips (*/). Tekst kald­kriipsu ja sul­gukriipsu vahel kä­sit­le­takse kom­men­taarina ja seda ei võeta koodi kom­pi­lee­ri­misel arvesse.

Do­ku­men­tat­siooni kom­men­taa­rid

Kuigi ühe­rea­lisi ja mit­me­rea­lisi kom­men­taare saab teo­ree­ti­li­selt lisada koodi mis tahes kohta, pai­gu­ta­takse do­ku­men­tat­sioo­ni­kom­men­taa­rid alati otse nende klasside või meetodite ette, mida nad kir­jel­da­vad. Töö­riis­tade abil loetakse need kom­men­taa­rid välja ja koon­da­takse HTML-do­ku­men­tat­siooni. Neid ka­su­ta­takse peamiselt me­ta­and­mete loomiseks autorite ja teatud tüüpi pa­ra­meet­rite jaoks. Need on märgitud sümboliga @. Do­ku­men­tat­siooni kom­men­taa­rid algavad kald­kriip­suga ja kahe tärniga (/**) ning lõpevad tärni ja kald­kriip­suga (*/).

Ühe­rea­li­sed kom­men­taa­rid

Et mõista, kuidas Java kom­men­taa­rid praktikas toimivad, vaatame mõned lihtsad näited. Saate neid ise proovida, et tulemust testida. Ühe­rea­line kom­men­taar algab kahe kald­kriip­suga ja võib olla kas eraldi real või pai­gu­ta­tud käskude järele. **. Siin on näide, kuidas kom­men­taar eraldi real välja näeb:

// 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.");
	}
}

Kui kasutate Java-käsku System.out.println, kuvatakse ainult lause „See on lõpus väl­jas­ta­tav tekst”. Kaks kom­men­taari kuvatakse ainult läh­te­koo­dis.

Al­ter­na­tiivina võite kom­men­taari lisada otse pärast käsku:

// 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.
	}
}

Kom­men­taari paigutus ei muuda väljundit.

Mit­me­rea­li­sed kom­men­taa­rid

Kui soovite oma koodi lisada mit­me­rea­lise kom­men­taari, võite selle lisada enne või pärast koodis olevaid juhiseid. Mit­me­rea­li­sed kom­men­taa­rid algavad alati kald­kriip­suga ja tärniga. Siin on mit­me­rea­line kom­men­taar enne koodi juhiseid:

/* 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.");
	}
}

Väl­jun­diks on „See on tekst, mis kuvatakse lõpus.“.

Siin on juhised kom­men­taari li­sa­miseks juhiste alla:

// 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. */
	}
}

Väljund peaks olema sama kui eelmises näites. Koo­di­l­õigu esimeses reas olev ühe­rea­line kom­men­taar ei kuvata samuti. Tärni ja kald­kriipsu võib paigutada otse kom­men­taari järele või kasutada eraldi rida.

Do­ku­men­tat­siooni kom­men­taa­rid

Do­ku­men­tat­siooni kom­men­taa­rid toimivad sarnaselt plokk­kom­men­taa­ri­dega, kuid neid eelneb kald­kriips ja kaks tärni. See võimaldab do­ku­men­tat­sioo­ni­töö­riis­ta­del kom­men­taare kasutada do­ku­men­tat­siooni loomiseks. Vajaduse korral võivad need sisaldada ka HTML-sildid, nagu <h1>, <p> või <strong>.

Javadoc, po­pu­laarne tööriist, mida saab kasutada do­ku­men­tat­siooni kom­men­taa­ride lu­ge­miseks, kasutab ka teisi kasulikke sildid. Siin on mõned olu­li­se­mad neist:

939263ef5a1ac120c2d75264caf221db

edce228102b28ab853cbac3b5c49eec0