The Java komentāri ir paziņojumi programmā, kurus neizpilda kompilators un tulks.
Kāpēc kodā izmantojam komentārus?
- Komentāri tiek izmantoti, lai padarītu programmu lasāmāku, pievienojot koda informāciju.
- Tas ļauj viegli uzturēt kodu un viegli atrast kļūdas.
- Komentārus var izmantot, lai sniegtu informāciju vai paskaidrojumus par mainīgs , metode, klasē , vai jebkuru paziņojumu.
- To var arī izmantot, lai novērstu programmas koda izpildi, testējot alternatīvo kodu.
Java komentāru veidi
Java ir trīs veidu komentāri.
- Vienas rindiņas komentārs
- Vairāku rindiņu komentārs
- Dokumentācijas komentārs
1) Java vienas rindiņas komentārs
Vienas rindiņas komentārs tiek izmantots, lai komentētu tikai vienu koda rindiņu. Tas ir plaši izmantotais un vienkāršākais veids, kā komentēt apgalvojumus.
Vienas rindiņas komentāri sākas ar divām slīpsvītrām (//) . Jebkurš teksts // priekšā netiek izpildīts Java.
Sintakse:
//This is single line comment
Izmantosim vienas rindas komentāru Java programmā.
KomentārsPiemērs1.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 } }
Izvade:
10
2) Java vairāku rindiņu komentārs
Vairāku rindiņu komentārs tiek izmantots, lai komentētu vairākas koda rindiņas. To var izmantot, lai izskaidrotu sarežģītu koda fragmentu vai komentētu vairākas koda rindiņas vienlaikus (jo tur būs grūti izmantot vienas rindiņas komentārus).
Vairāku rindiņu komentāri ir novietoti starp /* un */. Java neizpilda tekstu starp /* un */.
Sintakse:
Android iestatījumu izvēlne
/* This is multi line comment */
Izmantosim vairāku rindiņu komentāru Java programmā.
KomentārsPiemērs2.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 ); */ } }
Izvade:
10
Piezīme. Parasti // tiek izmantots īsiem komentāriem un /* */ tiek izmantots garākiem komentāriem.
3) Java dokumentācijas komentārs
Dokumentācijas komentāri parasti tiek izmantoti, lai rakstītu lielas programmas projektam vai programmatūras lietojumprogrammai, jo tie palīdz izveidot dokumentācijas API. Šīs API ir nepieciešamas atsaucei, t.i., kuras klases, metodes, argumenti utt. tiek izmantotas kodā.
Lai izveidotu dokumentācijas API, mums ir jāizmanto javadoc rīks . Dokumentācijas komentāri atrodas starp /** un */.
Sintakse:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc tagi
Daži no dokumentācijas komentāros bieži lietotajiem tagiem:
Tag | Sintakse | Apraksts |
---|---|---|
{@docRoot} | {@docRoot} | lai attēlotu relatīvo ceļu uz ģenerētā dokumenta saknes direktoriju no jebkuras lapas. |
@autors | @autora vārds - teksts | Lai pievienotu klases autoru. |
@kods | {@koda teksts} | Lai parādītu tekstu koda fontā, neinterpretējot to kā html marķējumu vai ligzdotu javadoc tagu. |
@versija | @version version-text | Lai norādītu apakšvirsrakstu 'Versija' un versijas tekstu, ja tiek izmantota opcija -version. |
@kopš | @kopš izlaišanas | Lai ģenerētajai dokumentācijai pievienotu virsrakstu 'Kopš' ar tekstu kopš. |
@param | @param parametra nosaukuma apraksts | Lai sadaļai 'Parametri' pievienotu parametru ar doto nosaukumu un aprakstu. |
@atgriezties | @atgriezties apraksts | Nepieciešams katrai metodei, kas kaut ko atgriež (izņemot nederīgu) |
Izmantosim Javadoc tagu Java programmā.
Aprēķināt.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>
Kompilējiet to, izmantojot javac rīku:
Izveidot dokumentu
Izveidot dokumentācijas API līdz javadoc rīks:
Tagad HTML faili ir izveidoti Aprēķināt klase pašreizējā direktorijā, t.i., abcDemo . Atveriet HTML failus, un mēs redzēsim Aprēķināt klases skaidrojumu, kas sniegts dokumentācijas komentārā.
Vai Java komentāri ir izpildāmi?
Gadi: Kā zināms, Java komentārus neizpilda kompilators vai tulks, tomēr pirms koda leksiskās transformācijas kompilatorā koda saturs tiek iekodēts ASCII, lai atvieglotu apstrādi.
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!!'); } }
Izvade:
Iepriekš minētais kods ģenerē izvadi, jo kompilators parsē unikoda rakstzīmi u000d kā jauna līnija pirms leksiskās transformācijas, un tādējādi kods tiek pārveidots, kā parādīts zemāk:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } }
Tādējādi Unikoda rakstzīme pārceļ drukas paziņojumu uz nākamo rindiņu, un tas tiek izpildīts kā parasts Java kods.