The Jáva komentáře jsou příkazy v programu, které nejsou prováděny kompilátorem a interpretem.
Proč v kódu používáme komentáře?
- Komentáře se používají ke zlepšení čitelnosti programu přidáním podrobností o kódu.
- Usnadňuje údržbu kódu a snadné nalezení chyb.
- Komentáře lze použít k poskytnutí informací nebo vysvětlení o variabilní , metoda, třída , nebo jakékoli prohlášení.
- Může být také použit k zabránění spuštění programového kódu při testování alternativního kódu.
Typy Java komentářů
V Javě existují tři typy komentářů.
- Jednořádkový komentář
- Víceřádkový komentář
- Komentář k dokumentaci
1) Java Single Line Comment
Jednořádkový komentář se používá pro okomentování pouze jednoho řádku kódu. Je to široce používaný a nejjednodušší způsob komentování výroků.
Jednořádkové komentáře začínají dvěma lomítky (//) . Jakýkoli text před // není spuštěn Java.
Syntax:
//This is single line comment
Použijme jednořádkový komentář v programu Java.
KomentářPříklad1.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ýstup:
10
2) Java Multi Line Comment
Víceřádkový komentář se používá ke komentování více řádků kódu. Lze jej použít k vysvětlení složitého úryvku kódu nebo ke komentování více řádků kódu současně (protože tam bude obtížné používat jednořádkové komentáře).
Víceřádkové komentáře jsou umístěny mezi /* a */. Jakýkoli text mezi /* a */ Java nespustí.
Syntax:
rozdíl mezi binárním stromem a binárním vyhledávacím stromem
/* This is multi line comment */
Použijme víceřádkový komentář v programu Java.
KomentářPříklad2.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ýstup:
10
Poznámka: Obvykle se // používá pro krátké komentáře a /* */ se používá pro delší komentáře.
3) Komentář k dokumentaci Java
Komentáře k dokumentaci se obvykle používají k psaní velkých programů pro projekt nebo softwarovou aplikaci, protože pomáhají vytvářet API pro dokumentaci. Tato rozhraní API jsou potřebná pro referenci, tj. jaké třídy, metody, argumenty atd. se používají v kódu.
K vytvoření dokumentačního API musíme použít nástroj javadoc . Komentáře k dokumentaci jsou umístěny mezi /** a */.
Syntax:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc tagy
Některé z běžně používaných značek v komentářích k dokumentaci:
Štítek | Syntax | Popis |
---|---|---|
{@docRoot} | {@docRoot} | k zobrazení relativní cesty ke kořenovému adresáři generovaného dokumentu z libovolné stránky. |
@autor | @jméno autora - text | Chcete-li přidat autora třídy. |
@kód | {@code text} | Chcete-li zobrazit text v kódovém písmu, aniž byste jej interpretovali jako značku html nebo vnořenou značku javadoc. |
@verze | @verze verze-text | Chcete-li zadat podnadpis 'Verze' a text verze, když je použita volba -version. |
@od té doby | @od vydání | Chcete-li do vygenerované dokumentace přidat nadpis 'Od' s textem od. |
@param | @param popis názvu parametru | Chcete-li přidat parametr s daným názvem a popisem do sekce 'Parametry'. |
@vrátit se | @návratový popis | Povinné pro každou metodu, která něco vrací (kromě void) |
Použijme značku Javadoc v programu Java.
Vypočítat.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>
Zkompilujte jej pomocí nástroje Javac:
Vytvořit dokument
Vytvořte API pro dokumentaci pomocí javadoc nástroj:
Nyní jsou vytvořeny soubory HTML pro Vypočítat třídy v aktuálním adresáři, tj. abcDemo . Otevřete soubory HTML a můžeme vidět vysvětlení třídy Calculate poskytnuté prostřednictvím komentáře k dokumentaci.
Jsou Java komentáře spustitelné?
roky: Jak víme, Java komentáře nejsou prováděny kompilátorem ani interpretem, ale před lexikální transformací kódu v kompilátoru je obsah kódu zakódován do ASCII, aby bylo zpracování jednodušší.
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ýstup:
Výše uvedený kód generuje výstup, protože kompilátor analyzuje znak Unicode u000d jako nový řádek před lexikální transformací, a proto je kód transformován, jak je uvedeno níže:
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 tedy posune tiskový příkaz na další řádek a provede se jako normální kód Java.