Kas ir Java komentāri un kā tos izveidot

Java ir trīs dažādi komentāru veidi. Ko­men­tā­rus var izmantot, lai struk­tu­rē­tu un pa­skaid­ro­tu savu kodu. Vien­rin­das komentāri ir paredzēti īsām piezīmēm, bet bloka komentāri ir piemēroti garākiem pa­skaid­ro­ju­miem. Do­ku­men­tā­ci­jas komentāri, savukārt, ir plaši un piedāvā vērtību, kas pārsniedz avota kodu.

Kas ir Java komentāri?

Darbs ar avota kodu dažkārt var radīt problēmas pat pie­re­dzē­ju­šiem iz­strā­dā­tā­jiem. Atkarībā no projekta un tā apjoma, situācija var kļūt ne­pa­re­dza­ma, un kods var kļūt neskaidrs. Šādos gadījumos jūs varbūt ne­vē­la­ties strādāt ar kodu vienatnē. Bet pat ja jūs vēlaties, lai citi varētu piekļūt jūsu kodam, viņi varbūt nespēs to intuitīvi saprast.

Lai palīdzētu iz­vai­rī­ties no pār­pra­tu­miem un struk­tu­rē­tu kodu skaidrāk, Java piedāvā lie­to­tā­jiem iespēju rakstīt ko­men­tā­rus. Šajā prog­ram­mē­ša­nas valodā ko­men­tā­rus var izmantot, lai iz­skaid­ro­tu savu domāšanas procesu, aprēķinus, metodes, klases vai struk­tū­ras. Kad jūs vai kāds cits vēlāk apskatīs kodu, komentāri atvieglos darbu ar kodu.

Lai komentāri būtu efektīvi, ir svarīgi, lai tie būtu pēc iespējas īsāki. Tajā pašā laikā tiem jā­no­d­ro­ši­na la­sī­tā­jiem pie­tie­ka­ma in­for­mā­ci­ja. Problēmu ri­si­nā­ša­nā ir ļoti svarīgi labi formulēti komentāri.

Java komentāri ir pieejami trīs dažādās versijās: vien­rin­das komentāri, bloka komentāri (vai­rākrin­das komentāri) un do­ku­men­tā­ci­jas komentāri. Visi komentāri ir atzīmēti, lai tos neņemtu vērā kom­pi­lē­ša­nas laikā. Turp­mā­ka­jās sadaļās mēs parādīsim, kā izveidot Java ko­men­tā­rus un kad katru no tiem lietot.

Kādi komentāru veidi ir Java?

Atkarībā no in­for­mā­ci­jas veida, ko vēlaties uzrakstīt, Java piedāvā trīs dažādus komentāru veidus. Tie ir:

Vien­rin­das komentāri

Šī ir vien­kār­šā­kā komentāra opcija. Šāda veida komentārs tiek izveidots, iz­man­to­jot divus secīgus slīpsvīt­ru simbolus (//), un tas nedrīkst būt garāks par vienu rindu. Vien­rin­das ko­men­tā­riem nav ne­pie­cie­šams norādīt beigu punktu, jo tas tiek au­to­mā­tis­ki sasniegts rindas beigās. Šāda veida Java komentāri ir piemēroti īsiem ko­men­tā­riem, kas ar dažiem vārdiem izskaidro funkciju.

Daudzrin­du komentāri

Ja jūsu pa­skaid­ro­ju­miem ir jābūt nedaudz garākiem, varat izmantot vai­rākrin­du ko­men­tā­rus. Teo­rē­tis­ki tie var būt jebkura garuma. Tie ir piemēroti, lai iekļautu al­ter­na­tī­vas koda rindas, kas ir izslēgtas no kom­pi­lā­ci­jas, vai de­ta­li­zē­tus pa­skaid­ro­ju­mus. Daudzrin­du komentāri tiek ievadīti ar slīpsvīt­ru un zvaigznī­ti (/*). Kad sa­snie­dzat komentāra beigas, jums vienkārši jā­ie­rak­sta zvaigznī­te, kam seko slīpsvīt­ra (*/). Teksts starp ie­va­dī­ša­nas slīpsvīt­ru un noslēguma slīpsvīt­ru tiek uzskatīts par komentāru un netiek ņemts vērā, kom­pi­lē­jot kodu.

Do­ku­men­tā­ci­jas komentāri

Lai gan vien­rin­das un daudzrin­das ko­men­tā­rus teo­rē­tis­ki var ievietot jebkurā avota koda vietā, do­ku­men­tā­ci­jas komentāri vienmēr tiek ievietoti tieši pirms klasēm vai metodēm, kuras tie apraksta. Ar rīku palīdzību šie komentāri tiek nolasīti un apkopoti HTML do­ku­men­tā­ci­jā. Tie gal­ve­no­kārt tiek izmantoti, lai radītu metadatus autoriem un no­teik­tiem parametru veidiem. Tie tiek atzīmēti ar simbolu @. Do­ku­men­tā­ci­jas komentāri tiek ievadīti ar slīpsvīt­ru un divām zvaigznī­tēm (/**) un beidzas ar zvaigznī­ti un slīpsvīt­ru (*/).

Vien­rin­das komentāri

Lai saprastu, kā Java komentāri darbojas praksē, ap­ska­tī­sim dažus vien­kār­šus piemērus. Jūs varat tos izmēģināt pats, lai pār­bau­dī­tu rezultātu. Vien­rin­das komentārs sākas ar diviem slīpsvīt­rām un var atrasties atsevišķā rindā vai pēc virknes ins­truk­ci­ju. **. Šeit redzams, kā komentārs izskatās atsevišķā rindā:

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

Ja iz­man­to­jat Java komandu System.out.println, tiks parādīts tikai teikums „Šis ir teksts, kas tiek izvadīts beigās”. Abi komentāri pa­rā­dī­sies tikai avota kodā.

Al­ter­na­tī­vi, jūs varat ievietot komentāru tieši pēc komandas:

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

Komentāra no­vie­to­jums nemaina izvades saturu.

Daudzrin­du komentāri

Ja vēlaties ievietot vairāku rindu komentāru savā kodā, to varat iekļaut pirms vai pēc ins­truk­ci­jām savā kodā. Vairāku rindu komentāri vienmēr tiek ievadīti ar slīpsvīt­ru un zvaigznī­ti. Šeit ir vairāku rindu komentārs pirms koda ins­truk­ci­jām:

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

Rezultāts ir šāds: „Šis ir teksts, kas tiks izvadīts beigās.”

Šeit ir norādīts, kā ievietot komentāru zem ins­truk­ci­jām:

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

Rezultāts būs tāds pats kā ie­priek­šē­jā piemērā. Vien­rin­das komentārs koda fragmenta pirmajā rindā arī netiks izvadīts. Zvaigznī­ti un slīpsvīt­ru varat ievietot tieši pēc komentāra vai izmantot atsevišķu rindu.

Do­ku­men­tā­ci­jas komentāri

Do­ku­men­tā­ci­jas komentāri darbojas līdzīgi kā bloka komentāri, bet tos ievada ar slīpsvīt­ru un diviem zvaigznī­šiem. Tas ļauj do­ku­men­tā­ci­jas rīkiem izmantot ko­men­tā­rus, lai izveidotu do­ku­men­tā­ci­ju. Ja ne­pie­cie­šams, tie var saturēt arī HTML tagus, piemēram, <h1>, <p> vai <strong>.

Javadoc, populārs rīks, ko var izmantot, lai nolasītu do­ku­men­tā­ci­jas ko­men­tā­rus, izmanto arī citas noderīgas birkas. Šeit ir dažas no sva­rī­gā­ka­jām:

939263ef5a1ac120c2d75264caf221db

7b0ed9d2883272aca77983e730a08231

b67bb6e28836498560dfa605563223f0