The Java komentari su naredbe u programu koje ne izvode kompilator i interpreter.
Zašto koristimo komentare u kodu?
- Komentari se koriste kako bi program bio čitljiviji dodavanjem pojedinosti koda.
- Olakšava održavanje koda i lako pronalaženje pogrešaka.
- Komentari se mogu koristiti za pružanje informacija ili objašnjenja o varijabla , metoda, razreda , ili bilo koju izjavu.
- Također se može koristiti za sprječavanje izvršavanja programskog koda tijekom testiranja alternativnog koda.
Vrste Java komentara
U Javi postoje tri vrste komentara.
- Jednoredni komentar
- Višeredni komentar
- Komentar dokumentacije
1) Java jednoredni komentar
Jednoredni komentar koristi se za komentiranje samo jednog retka koda. To je široko korišten i najlakši način komentiranja izjava.
Komentari u jednom retku počinju s dvije kose crte (//) . Bilo koji tekst ispred // ne izvršava Java.
Sintaksa:
//This is single line comment
Upotrijebimo komentar u jednom redu u Java programu.
KomentarPrimjer1.java
public class CommentExample1 { public static void main(String[] args) { int i=10; // i is a variable with value 10 System.out.println(i); //printing the variable i } }
Izlaz:
10
2) Java višeredni komentar
Komentar s više redaka koristi se za komentiranje više redaka koda. Može se koristiti za objašnjenje složenog isječka koda ili za komentiranje više redaka koda odjednom (budući da će tamo biti teško koristiti komentare u jednom retku).
Višeredni komentari smješteni su između /* i */. Bilo koji tekst između /* i */ Java ne izvršava.
Sintaksa:
spremiti youtube video vlc
/* This is multi line comment */
Upotrijebimo višeredni komentar u Java programu.
KomentarPrimjer2.java
public class CommentExample2 { public static void main(String[] args) { /* Let's declare and print variable in java. */ int i=10; System.out.println(i); /* float j = 5.9; float k = 4.4; System.out.println( j + k ); */ } }
Izlaz:
10
Napomena: Obično se // koristi za kratke komentare, a /* */ za duže komentare.
3) Komentar Java dokumentacije
Komentari dokumentacije obično se koriste za pisanje velikih programa za projekt ili softversku aplikaciju jer pomažu u stvaranju API-ja dokumentacije. Ti su API-ji potrebni za referencu, tj. koje se klase, metode, argumenti itd. koriste u kodu.
Za izradu API-ja za dokumentaciju moramo koristiti javadoc alat . Komentari dokumentacije smješteni su između /** i */.
Sintaksa:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc oznake
Neke od često korištenih oznaka u komentarima dokumentacije:
Označiti | Sintaksa | Opis |
---|---|---|
{@docRoot} | {@docRoot} | za prikaz relativnog puta do korijenskog direktorija generiranog dokumenta s bilo koje stranice. |
@Autor | @ime autora - tekst | Za dodavanje autora klase. |
@kodirati | {@code text} | Za prikaz teksta u fontu koda bez tumačenja kao html oznake ili ugniježđene javadoc oznake. |
@verzija | @verzija verzija-tekst | Za određivanje podnaslova 'Verzija' i teksta verzije kada se koristi opcija -verzija. |
@od | @od izdanja | Za dodavanje naslova 'Od' s tekstom od u generiranu dokumentaciju. |
@param | @param opis imena parametra | Za dodavanje parametra s danim imenom i opisom u odjeljak 'Parametri'. |
@povratak | @return opis | Obavezno za svaku metodu koja nešto vraća (osim void) |
Upotrijebimo Javadoc oznaku u Java programu.
Izračunaj.java
import java.io.*; /** * <h2> Calculation of numbers </h2> * This program implements an application * to perform operation such as addition of numbers * and print the result * <p> * <b>Note:</b> Comments make the code readable and * easy to understand. * * @author Anurati * @version 16.0 * @since 2021-07-06 */ public class Calculate{ /** * This method calculates the summation of two integers. * @param input1 This is the first parameter to sum() method * @param input2 This is the second parameter to the sum() method. * @return int This returns the addition of input1 and input2 */ public int sum(int input1, int input2){ return input1 + input2; } /** * This is the main method uses of sum() method. * @param args Unused * @see IOException */ public static void main(String[] args) { Calculate obj = new Calculate(); int result = obj.sum(40, 20); System.out.println('Addition of numbers: ' + result); } } </p>
Kompajlirajte ga alatom javac:
Stvori dokument
API za izradu dokumentacije prema javadoc alat:
Sada su HTML datoteke stvorene za Izračunati klasa u trenutnom direktoriju, tj. abcDemo . Otvorite HTML datoteke i možemo vidjeti objašnjenje klase Calculate dano kroz komentar dokumentacije.
Jesu li Java komentari izvršni?
Godine: Kao što znamo, Java komentare ne izvršava kompilator ili interpreter, međutim, prije leksičke transformacije koda u prevoditelju, sadržaj koda se kodira u ASCII kako bi se obrada učinila jednostavnom.
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } }
Izlaz:
Gornji kod generira izlaz jer kompajler analizira Unicode znak u000d kao nova linija prije leksičke transformacije, pa se kod transformira kako je prikazano u nastavku:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } }
Dakle, Unicode znak pomiče naredbu za ispis u sljedeći redak i izvršava se kao normalan Java kod.