Det Java kommentarer er udsagn i et program, som ikke udføres af compileren og fortolkeren.
Hvorfor bruger vi kommentarer i en kode?
- Kommentarer bruges til at gøre programmet mere læsbart ved at tilføje kodens detaljer.
- Det gør det nemt at vedligeholde koden og at finde fejlene nemt.
- Kommentarerne kan bruges til at give information eller forklaring om variabel , metode, klasse eller en hvilken som helst erklæring.
- Den kan også bruges til at forhindre udførelse af programkode, mens den alternative kode testes.
Typer af Java-kommentarer
Der er tre typer kommentarer i Java.
- Enkeltlinjekommentar
- Multi Line Kommentar
- Dokumentationskommentar
1) Java Single Line Comment
Enkeltlinjekommentaren bruges til kun at kommentere én linje i koden. Det er den meget brugte og nemmeste måde at kommentere udtalelserne på.
Enkeltlinjekommentarer starter med to skråstreger (//) . Enhver tekst foran // udføres ikke af Java.
Syntaks:
//This is single line comment
Lad os bruge en enkelt linjekommentar i et Java-program.
KommentarEksempel1.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
Flerlinjekommentaren bruges til at kommentere flere linjer kode. Det kan bruges til at forklare et komplekst kodestykke eller til at kommentere flere linjer kode ad gangen (da det vil være svært at bruge enkeltlinjekommentarer der).
Kommentarer med flere linjer placeres mellem /* og */. Enhver tekst mellem /* og */ udføres ikke af Java.
Syntaks:
tyre vs okse
/* This is multi line comment */
Lad os bruge multi-line kommentar i et Java-program.
KommentarEksempel2.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
Bemærk: Normalt bruges // til korte kommentarer og /* */ bruges til længere kommentarer.
3) Java-dokumentationskommentar
Dokumentationskommentarer bruges normalt til at skrive store programmer til et projekt eller softwareapplikation, da det hjælper med at skabe dokumentations-API. Disse API'er er nødvendige til reference, dvs. hvilke klasser, metoder, argumenter osv., der bruges i koden.
For at oprette dokumentations-API skal vi bruge javadoc værktøj . Dokumentationskommentarerne er placeret mellem /** og */.
Syntaks:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc tags
Nogle af de almindeligt anvendte tags i dokumentationskommentarer:
| Tag | Syntaks | Beskrivelse |
|---|---|---|
| {@docRoot} | {@docRoot} | for at afbilde den relative sti til rodbiblioteket for det genererede dokument fra en hvilken som helst side. |
| @forfatter | @forfatternavn - tekst | For at tilføje forfatteren til klassen. |
| @kode | {@kodetekst} | At vise teksten i kodeskrifttype uden at fortolke den som html-markering eller indlejret javadoc-tag. |
| @version | @version version-tekst | For at angive 'Version' underoverskrift og version-tekst, når -version option bruges. |
| @siden | @siden udgivelsen | For at tilføje 'Siden' overskrift med siden tekst til genereret dokumentation. |
| @param | @param parameternavn beskrivelse | For at tilføje en parameter med givet navn og beskrivelse til 'Parameters' sektionen. |
| @Vend tilbage | @returbeskrivelse | Påkrævet for hver metode, der returnerer noget (undtagen ugyldig) |
Lad os bruge Javadoc-tagget i et Java-program.
Calculate.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> Kompiler det med javac værktøj:
Opret dokument
Opret dokumentations-API ved javadoc værktøj:
Nu er HTML-filerne oprettet til Beregn klasse i den aktuelle mappe, dvs. abcDemo . Åbn HTML-filerne, og vi kan se forklaringen af Calculate class givet gennem dokumentationskommentaren.
Er Java-kommentarer eksekverbare?
Flere år: Som vi ved, udføres Java-kommentarer ikke af compileren eller fortolkeren, men før den leksikalske transformation af kode i compiler, kodes indholdet af koden ind i ASCII for at gøre behandlingen nem.
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!!'); } } Produktion:
Ovenstående kode genererer output, fordi compileren parser Unicode-tegnet u000d som en ny linje før den leksikalske transformation, og dermed transformeres koden som vist nedenfor:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Unicode-tegnet flytter således print-sætningen til næste linje, og den udføres som en normal Java-kode.