De Java kommentarer er setningene i et program som ikke kjøres av kompilatoren og tolken.
Hvorfor bruker vi kommentarer i en kode?
- Kommentarer brukes for å gjøre programmet mer lesbart ved å legge til detaljene i koden.
- Det gjør det enkelt å vedlikeholde koden og å finne feilene enkelt.
- Kommentarene kan brukes til å gi informasjon eller forklaring om variabel , metode, klasse , eller en hvilken som helst uttalelse.
- Den kan også brukes til å forhindre kjøring av programkode mens du tester den alternative koden.
Typer Java-kommentarer
Det er tre typer kommentarer i Java.
- Enkeltlinjekommentar
- Flerlinjekommentar
- Dokumentasjonskommentar
1) Java Single Line Comment
Enkeltlinjekommentaren brukes til å kommentere bare én linje i koden. Det er den mye brukte og enkleste måten å kommentere utsagnene på.
Enkeltlinjekommentarer starter med to skråstreker fremover (//) . Eventuell tekst foran // kjøres ikke av Java.
Syntaks:
//This is single line comment
La oss bruke enkeltlinjekommentarer i et 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 } }
Produksjon:
10
2) Java Multi Line Kommentar
Flerlinjekommentaren brukes til å kommentere flere linjer med kode. Den kan brukes til å forklare en kompleks kodebit eller kommentere flere linjer med kode om gangen (da det vil være vanskelig å bruke enkeltlinjekommentarer der).
Flerlinjekommentarer plasseres mellom /* og */. Eventuell tekst mellom /* og */ kjøres ikke av Java.
Syntaks:
java-listen er tom
/* This is multi line comment */
La oss bruke flerlinjekommentarer i et 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 ); */ } }
Produksjon:
10
Merk: Vanligvis brukes // for korte kommentarer og /* */ brukes for lengre kommentarer.
3) Java Dokumentasjonskommentar
Dokumentasjonskommentarer brukes vanligvis til å skrive store programmer for et prosjekt eller programvare, da det hjelper å lage dokumentasjons-API. Disse API-ene er nødvendige for referanse, dvs. hvilke klasser, metoder, argumenter osv. som brukes i koden.
For å lage dokumentasjons-API, må vi bruke javadoc-verktøy . Dokumentasjonskommentarene er plassert mellom /** og */.
Syntaks:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc-tagger
Noen av de vanligste taggene i dokumentasjonskommentarer:
stikkord | Syntaks | Beskrivelse |
---|---|---|
{@docRoot} | {@docRoot} | for å vise relativ bane til rotkatalogen til generert dokument fra en hvilken som helst side. |
@forfatter | @forfatternavn - tekst | For å legge til forfatteren av klassen. |
@kode | {@kodetekst} | For å vise teksten i kodeskrift uten å tolke den som html-markering eller nestet javadoc-tag. |
@versjon | @versjon versjon-tekst | For å spesifisere 'Versjon' underoverskrift og versjonstekst når -versjon-alternativet brukes. |
@siden | @siden utgivelsen | For å legge til 'Siden'-overskrift med siden-tekst i generert dokumentasjon. |
@param | @param parameternavn beskrivelse | For å legge til en parameter med gitt navn og beskrivelse til 'Parameters'-delen. |
@komme tilbake | @returbeskrivelse | Påkrevd for hver metode som returnerer noe (unntatt ugyldig) |
La oss bruke Javadoc-koden 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-verktøyet:
Opprett dokument
Lag dokumentasjons-API av javadoc verktøy:
Nå er HTML-filene opprettet for Regne ut klasse i gjeldende katalog, dvs. abcDemo . Åpne HTML-filene, og vi kan se forklaringen av Calculate class gitt gjennom dokumentasjonskommentaren.
Er Java-kommentarer kjørbare?
År: Som vi vet, blir ikke Java-kommentarer utført av kompilatoren eller tolken, men før den leksikalske transformasjonen av kode i kompilatoren, blir innholdet i koden kodet inn i ASCII for å gjøre behandlingen enkel.
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!!'); } }
Produksjon:
Koden ovenfor genererer utdata fordi kompilatoren analyserer Unicode-tegnet u000d som en ny linje før den leksikalske transformasjonen, og dermed blir koden transformert 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!!'); } }
Dermed flytter Unicode-tegnet utskriftssetningen til neste linje, og den utføres som en vanlig Java-kode.