The Java komentáre sú príkazy v programe, ktoré nie sú vykonávané kompilátorom a tlmočníkom.
Prečo používame komentáre v kóde?
- Komentáre sa používajú na zlepšenie čitateľnosti programu pridaním podrobností o kóde.
- Uľahčuje údržbu kódu a ľahké nájdenie chýb.
- Komentáre môžu byť použité na poskytnutie informácií alebo vysvetlení o premenlivý , metóda, trieda alebo akékoľvek vyhlásenie.
- Môže sa tiež použiť na zabránenie spusteniu programového kódu počas testovania alternatívneho kódu.
Typy komentárov Java
V Jave sú tri typy komentárov.
- Jednoriadkový komentár
- Viacriadkový komentár
- Komentár k dokumentácii
1) Jednoriadkový komentár Java
Jednoriadkový komentár sa používa na komentovanie iba jedného riadku kódu. Je to najpoužívanejší a najjednoduchší spôsob komentovania vyhlásení.
Jednoriadkové komentáre začínajú dvoma lomkami (//) . Akýkoľvek text pred // Java nevykonáva.
Syntax:
//This is single line comment
Použime jednoriadkový komentár v programe Java.
CommentExample1.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 } } Výkon:
10
2) Java Multi Line Comment
Viacriadkový komentár sa používa na komentovanie viacerých riadkov kódu. Dá sa použiť na vysvetlenie zložitého úryvku kódu alebo na komentovanie viacerých riadkov kódu naraz (pretože tam bude ťažké použiť jednoriadkové komentáre).
Viacriadkové komentáre sú umiestnené medzi /* a */. Akýkoľvek text medzi /* a */ Java nevykonáva.
Syntax:
Oracle sql sa nerovná
/* This is multi line comment */
Využime viacriadkový komentár v programe Java.
CommentExample2.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 ); */ } } Výkon:
10
Poznámka: Zvyčajne // sa používa pre krátke komentáre a /* */ sa používa pre dlhšie komentáre.
3) Komentár k dokumentácii Java
Komentáre k dokumentácii sa zvyčajne používajú na písanie veľkých programov pre projekt alebo softvérovú aplikáciu, pretože pomáhajú vytvárať API pre dokumentáciu. Tieto API sú potrebné pre referenciu, t.j. ktoré triedy, metódy, argumenty atď. sa používajú v kóde.
Na vytvorenie dokumentačného API musíme použiť nástroj javadoc . Komentáre k dokumentácii sú umiestnené medzi /** a */.
Syntax:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc tagy
Niektoré z bežne používaných značiek v komentároch k dokumentácii:
| Tag | Syntax | Popis |
|---|---|---|
| {@docRoot} | {@docRoot} | na zobrazenie relatívnej cesty ku koreňovému adresáru vygenerovaného dokumentu z ľubovoľnej stránky. |
| @autor | @meno autora - text | Ak chcete pridať autora triedy. |
| @kód | {@code text} | Ak chcete zobraziť text v kódovom písme bez toho, aby sa interpretoval ako značka html alebo vnorená značka javadoc. |
| @verzia | @verzia verzia-text | Ak chcete zadať podnadpis 'Verzia' a text verzie, keď sa použije voľba -version. |
| @odkedy | @od vydania | Ak chcete do vygenerovanej dokumentácie pridať nadpis 'Od' s textom odvtedy. |
| @param | @param popis názvu parametra | Pridanie parametra s daným názvom a popisom do sekcie 'Parametre'. |
| @návrat | @popis návratu | Vyžaduje sa pre každú metódu, ktorá niečo vracia (okrem neplatnosti) |
Použime značku Javadoc v programe Java.
Vypočítajte.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> Kompilujte ho pomocou nástroja Javac:
Vytvoriť dokument
Vytvorte dokumentačné API pomocou javadoc nástroj:
Teraz sú vytvorené súbory HTML pre Vypočítajte trieda v aktuálnom adresári, t.j. abcDemo . Otvorte súbory HTML a môžeme vidieť vysvetlenie triedy Calculate poskytnuté prostredníctvom komentára k dokumentácii.
Sú Java komentáre spustiteľné?
Roky: Ako vieme, Java komentáre nie sú vykonávané kompilátorom alebo tlmočníkom, ale pred lexikálnou transformáciou kódu v kompilátore je obsah kódu zakódovaný do ASCII, aby sa uľahčilo spracovanie.
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!!'); } } Výkon:
Vyššie uvedený kód generuje výstup, pretože kompilátor analyzuje znak Unicode u000d ako Nový riadok pred lexikálnou transformáciou, a preto sa kód transformuje, ako je uvedené nižšie:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Znak Unicode teda posunie tlačový príkaz na ďalší riadok a vykoná sa ako normálny kód Java.