The Java komentarji so stavki v programu, ki jih ne izvedeta prevajalnik in tolmač.
Zakaj uporabljamo komentarje v kodi?
- Komentarji se uporabljajo za boljšo berljivost programa z dodajanjem podrobnosti kode.
- Omogoča preprosto vzdrževanje kode in enostavno iskanje napak.
- Komentarji se lahko uporabijo za zagotavljanje informacij ali pojasnil o spremenljivka , metoda, razred , ali katero koli izjavo.
- Uporablja se lahko tudi za preprečitev izvajanja programske kode med preizkušanjem alternativne kode.
Vrste komentarjev Java
V Javi obstajajo tri vrste komentarjev.
- Enovrstični komentar
- Večvrstični komentar
- Komentar dokumentacije
1) Java enovrstični komentar
Enovrstični komentar se uporablja za komentiranje samo ene vrstice kode. Je najbolj razširjen in najlažji način komentiranja izjav.
Enovrstični komentarji se začnejo z dvema poševnicama naprej (//) . Nobenega besedila pred // Java ne izvede.
Sintaksa:
//This is single line comment
Uporabimo enovrstični komentar v programu Java.
KomentarExample1.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 } }
Izhod:
10
2) Večvrstični komentar Java
Večvrstični komentar se uporablja za komentiranje več vrstic kode. Uporablja se lahko za razlago zapletenega odrezka kode ali za komentiranje več vrstic kode hkrati (saj bo tam težko uporabiti komentarje v eni vrstici).
Večvrstični komentarji so postavljeni med /* in */. Nobenega besedila med /* in */ Java ne izvede.
Sintaksa:
kaj je samodejno ožičeno v Javi
/* This is multi line comment */
Uporabimo večvrstični komentar v programu Java.
KomentarExample2.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 ); */ } }
Izhod:
10
Opomba: // se običajno uporablja za kratke komentarje, /* */ pa za daljše komentarje.
3) Komentar dokumentacije Java
Dokumentacijski komentarji se običajno uporabljajo za pisanje velikih programov za projekt ali programsko aplikacijo, saj pomagajo ustvariti dokumentacijski API. Ti API-ji so potrebni za referenco, tj. kateri razredi, metode, argumenti itd. so uporabljeni v kodi.
Za ustvarjanje API-ja za dokumentacijo moramo uporabiti orodje javadoc . Komentarji dokumentacije so postavljeni med /** in */.
Sintaksa:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
oznake javadoc
Nekaj pogosto uporabljenih oznak v komentarjih dokumentacije:
Oznaka | Sintaksa | Opis |
---|---|---|
{@docRoot} | {@docRoot} | za prikaz relativne poti do korenskega imenika ustvarjenega dokumenta s katere koli strani. |
@avtor | @ime avtorja - besedilo | Če želite dodati avtorja razreda. |
@Koda | {@code text} | Za prikaz besedila v pisavi kode, ne da bi ga interpretirali kot oznako html ali ugnezdeno oznako javadoc. |
@različica | @version besedilo različice | Če želite določiti podnaslov 'Različica' in besedilo različice, ko je uporabljena možnost -version. |
@od | @od izdaje | Če želite v ustvarjeno dokumentacijo dodati naslov 'Od' z besedilom od. |
@param | opis imena parametra @param | Za dodajanje parametra z danim imenom in opisom v razdelek 'Parametri'. |
@vrnitev | opis @return | Zahtevano za vsako metodo, ki nekaj vrne (razen void) |
Uporabimo oznako Javadoc v programu Java.
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>
Prevedite ga z orodjem javac:
Ustvari dokument
Ustvari API za dokumentacijo z javadoc orodje:
Zdaj so datoteke HTML ustvarjene za Izračunaj razred v trenutnem imeniku, tj. abcDemo . Odprite datoteke HTML in videli bomo razlago razreda Calculate v komentarju dokumentacije.
Ali so komentarji Java izvršljivi?
leta: Kot vemo, komentarjev Java ne izvaja prevajalnik ali tolmač, vendar se pred leksikalno transformacijo kode v prevajalniku vsebina kode kodira v ASCII, da je obdelava enostavna.
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!!'); } }
Izhod:
Zgornja koda ustvari izhod, ker prevajalnik razčleni znak Unicode u000d kot nova vrstica pred leksikalno transformacijo in tako se koda transformira, kot je prikazano spodaj:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } }
Tako znak Unicode premakne stavek za tiskanje v naslednjo vrstico in se izvede kot običajna koda Java.