The Java comentariile sunt instrucțiunile dintr-un program care nu sunt executate de compilator și interpret.
De ce folosim comentarii într-un cod?
- Comentariile sunt folosite pentru a face programul mai lizibil prin adăugarea detaliilor codului.
- Ușurează întreținerea codului și găsirea erorilor cu ușurință.
- Comentariile pot fi folosite pentru a oferi informații sau explicații despre variabil , metoda, clasă , sau orice declarație.
- Poate fi folosit și pentru a preveni execuția codului programului în timpul testării codului alternativ.
Tipuri de comentarii Java
Există trei tipuri de comentarii în Java.
- Comentariu pe o singură linie
- Comentariu pe mai multe rânduri
- Comentariu de documentare
1) Comentariu Java Single Line
Comentariul pe o singură linie este folosit pentru a comenta doar o singură linie a codului. Este cel mai utilizat și cel mai simplu mod de a comenta afirmațiile.
Comentariile pe o singură linie încep cu două bare oblice (//) . Orice text din fața // nu este executat de Java.
Sintaxă:
//This is single line comment
Să folosim comentariul pe o singură linie într-un program Java.
ComentariuExemplu1.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 } } Ieșire:
10
2) Comentariu Java Multi Line
Comentariul pe mai multe linii este folosit pentru a comenta mai multe linii de cod. Poate fi folosit pentru a explica un fragment de cod complex sau pentru a comenta mai multe rânduri de cod simultan (deoarece va fi dificil să folosiți comentarii pe o singură linie acolo).
Comentariile pe mai multe rânduri sunt plasate între /* și */. Orice text între /* și */ nu este executat de Java.
Sintaxă:
numărul lui „euler” în java”
/* This is multi line comment */
Să folosim comentarii pe mai multe rânduri într-un program Java.
ComentariuExemplu2.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 ); */ } } Ieșire:
10
Notă: de obicei // este folosit pentru comentarii scurte și /* */ este folosit pentru comentarii mai lungi.
3) Comentariu despre documentația Java
Comentariile de documentare sunt de obicei folosite pentru a scrie programe mari pentru un proiect sau o aplicație software, deoarece ajută la crearea API-ului pentru documentație. Aceste API-uri sunt necesare pentru referință, adică ce clase, metode, argumente etc. sunt folosite în cod.
Pentru a crea documentație API, trebuie să folosim instrument javadoc . Comentariile documentației sunt plasate între /** și */.
Sintaxă:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
etichete javadoc
Unele dintre etichetele utilizate frecvent în comentariile documentației:
| Etichetă | Sintaxă | Descriere |
|---|---|---|
| {@docRoot} | {@docRoot} | pentru a descrie calea relativă către directorul rădăcină al documentului generat din orice pagină. |
| @autor | @numele autorului - text | Pentru a adăuga autorul clasei. |
| @cod | {@code text} | Pentru a afișa textul în fontul codului fără a-l interpreta ca markup html sau etichetă javadoc imbricată. |
| @versiune | @version versiune-text | Pentru a specifica subtitlul „Versiune” și textul versiunii atunci când este utilizată opțiunea -version. |
| @de cand | @de la lansare | Pentru a adăuga titlul „De când” cu textul din documentația generată. |
| @param | @param descrierea numelui parametrului | Pentru a adăuga un parametru cu nume și descriere la secțiunea „Parametri”. |
| @întoarcere | @return descriere | Necesar pentru fiecare metodă care returnează ceva (cu excepția void) |
Să folosim eticheta Javadoc într-un program Java.
Calculați.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> Compilați-l cu instrumentul javac:
Creați document
Creați documentația API de către javadoc instrument:
Acum, fișierele HTML sunt create pentru calculati clasa din directorul curent, adică abcDemo . Deschideți fișierele HTML și putem vedea explicația clasei Calculate oferită prin comentariul documentației.
Comentariile Java sunt executabile?
Ani: După cum știm, comentariile Java nu sunt executate de compilator sau interpret, totuși, înainte de transformarea lexicală a codului în compilator, conținutul codului este codificat în ASCII pentru a ușura procesarea.
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!!'); } } Ieșire:
Codul de mai sus generează rezultatul deoarece compilatorul analizează caracterul Unicode u000d ca linie nouă înainte de transformarea lexicală și astfel codul este transformat după cum se arată mai jos:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Astfel, caracterul Unicode mută instrucțiunea de imprimare pe linia următoare și este executat ca un cod Java normal.