logo

Java-kommentarer

De Java kommentarer är de påståenden i ett program som inte exekveras av kompilatorn och tolken.

Varför använder vi kommentarer i en kod?

  • Kommentarer används för att göra programmet mer läsbart genom att lägga till detaljerna i koden.
  • Det gör det enkelt att underhålla koden och att enkelt hitta felen.
  • Kommentarerna kan användas för att ge information eller förklaring om variabel , metod, klass , eller något uttalande.
  • Den kan också användas för att förhindra exekvering av programkod medan den alternativa koden testas.

Typer av Java-kommentarer

Det finns tre typer av kommentarer i Java.

  1. En rad kommentar
  2. Flerlinjekommentar
  3. Dokumentationskommentar
Java Typer av kommentarer

1) Java Single Line Comment

Enradskommentaren används för att kommentera endast en rad i koden. Det är det mest använda och enklaste sättet att kommentera uttalandena.

En rad kommentarer börjar med två snedstreck framåt (//) . All text framför // exekveras inte av Java.

Syntax:

 //This is single line comment 

Låt oss använda en rad kommentar i ett Java-program.

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

Produktion:

 10 

2) Java Multi Line Kommentar

Flerradskommentaren används för att kommentera flera rader kod. Den kan användas för att förklara ett komplext kodavsnitt eller för att kommentera flera rader kod åt gången (eftersom det kommer att vara svårt att använda enradskommentarer där).

Flerradiga kommentarer placeras mellan /* och */. All text mellan /* och */ exekveras inte av Java.

Syntax:

vad är awt
 /* This is multi line comment */ 

Låt oss använda flerradskommentarer i ett Java-program.

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

Produktion:

 10 

Notera: Vanligtvis används // för korta kommentarer och /* */ används för längre kommentarer.

3) Java-dokumentationskommentar

Dokumentationskommentarer används vanligtvis för att skriva stora program för ett projekt eller program eftersom det hjälper till att skapa dokumentations-API. Dessa API:er behövs för referens, d.v.s. vilka klasser, metoder, argument, etc. som används i koden.

För att skapa dokumentations-API måste vi använda javadoc verktyg . Dokumentationskommentarerna placeras mellan /** och */.

Syntax:

 /** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */ 

javadoc-taggar

Några av de vanligaste taggarna i dokumentationskommentarer:

Märka Syntax Beskrivning
{@docRoot} {@docRoot} för att avbilda den relativa sökvägen till rotkatalogen för genererat dokument från vilken sida som helst.
@författare @författarens namn - text För att lägga till författaren till klassen.
@koda {@kodtext} För att visa texten i kodtypsnitt utan att tolka den som html-kodning eller kapslad javadoc-tagg.
@version @version version-text För att ange 'Version' underrubrik och version-text när -version alternativet används.
@eftersom @sedan release För att lägga till rubriken 'Sedan' med sedan text till genererad dokumentation.
@param @param parameternamn beskrivning För att lägga till en parameter med angivet namn och beskrivning till avsnittet 'Parameters'.
@lämna tillbaka @retur beskrivning Krävs för varje metod som returnerar något (förutom ogiltiga)

Låt oss använda Javadoc-taggen i ett Java-program.

Beräkna.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(&apos;Addition of numbers: &apos; + result); } } </p>

Kompilera det med javac-verktyget:

Skapa dokument

java kommentarer

Skapa dokumentations-API av javadoc verktyg:

java kommentarer

Nu skapas HTML-filerna för Beräkna klass i den aktuella katalogen, dvs. abcDemo . Öppna HTML-filerna så kan vi se förklaringen av Calculate class som tillhandahålls genom dokumentationskommentaren.

Är Java-kommentarer körbara?

År: Som vi vet exekveras inte Java-kommentarer av kompilatorn eller tolken, men före den lexikaliska transformationen av kod i kompilatorn kodas innehållet i koden till ASCII för att göra bearbetningen enkel.

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println(&apos;Java comment is executed!!&apos;); } } 

Produktion:

java kommentarer

Ovanstående kod genererar utdata eftersom kompilatorn analyserar Unicode-tecknet u000d som en ny linje före den lexikala transformationen, och därmed transformeras koden som visas nedan:

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println(&apos;Java comment is executed!!&apos;); } } 

Således flyttar Unicode-tecknet utskriftssatsen till nästa rad och den exekveras som en normal Java-kod.