A Jáva A megjegyzések a program azon utasításai, amelyeket a fordító és az értelmező nem hajt végre.
Miért használunk megjegyzéseket egy kódban?
- A megjegyzések segítségével a program olvashatóbbá válik a kód részleteinek hozzáadásával.
- Ez megkönnyíti a kód karbantartását és a hibák könnyű megtalálását.
- A megjegyzések felhasználhatók információk vagy magyarázatok nyújtására a változó , módszer, osztály , vagy bármilyen kijelentés.
- Használható arra is, hogy megakadályozza a programkód végrehajtását az alternatív kód tesztelése közben.
Java megjegyzések típusai
A Java-ban háromféle megjegyzés létezik.
- Egysoros megjegyzés
- Többsoros megjegyzés
- Dokumentációs megjegyzés
1) Java egysoros megjegyzés
Az egysoros megjegyzés csak a kód egy sorának megjegyzésére szolgál. Ez a legszélesebb körben használt és legegyszerűbb módja az állítások kommentálásának.
Az egysoros megjegyzések két perjellel kezdődnek (//) . A // előtti szöveget a Java nem hajtja végre.
Szintaxis:
//This is single line comment
Használjunk egysoros megjegyzést egy Java programban.
MegjegyzésPélda1.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 } } Kimenet:
10
2) Java többsoros megjegyzés
A többsoros megjegyzés több kódsor megjegyzésére szolgál. Használható egy összetett kódrészlet magyarázatára, vagy több sornyi kód megjegyzésére is használható (mivel ott nehéz lesz egysoros megjegyzéseket használni).
A többsoros megjegyzések /* és */ közé kerülnek. A /* és */ közötti szövegeket a Java nem hajtja végre.
Szintaxis:
linkedlist és arraylist
/* This is multi line comment */
Használjunk többsoros megjegyzést egy Java programban.
MegjegyzésPélda2.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 ); */ } } Kimenet:
10
Megjegyzés: Általában a // a rövid megjegyzésekhez, a /* */ pedig a hosszabb megjegyzésekhez.
3) Java dokumentációs megjegyzés
A dokumentációs megjegyzéseket általában nagy programok írásához használják egy projekthez vagy szoftveralkalmazáshoz, mivel ez segít a dokumentációs API létrehozásában. Ezekre az API-kra referenciaként van szükség, azaz hogy mely osztályokat, metódusokat, argumentumokat stb. használjuk a kódban.
A dokumentációs API létrehozásához használnunk kell a javadoc eszköz . A dokumentáció megjegyzései /** és */ között helyezkednek el.
Szintaxis:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc címkék
Néhány gyakran használt címke a dokumentációhoz fűzött megjegyzésekben:
| Címke | Szintaxis | Leírás |
|---|---|---|
| {@docRoot} | {@docRoot} | a generált dokumentum gyökérkönyvtárának relatív elérési útjának ábrázolására bármely oldalról. |
| @szerző | @szerző neve - szöveg | Az osztály szerzőjének hozzáadása. |
| @kód | {@kódszöveg} | A szöveg kód betűtípussal való megjelenítése anélkül, hogy html jelölésként vagy beágyazott javadoc címkeként értelmezné. |
| @változat | @verzió verzió-szöveg | A 'Version' alcím és a version-text megadása a -version opció használatakor. |
| @mivel | @megjelenés óta | 'Amióta' címsor és mivel szöveg hozzáadása a generált dokumentációhoz. |
| @param | @param paraméter-név leírás | Adott névvel és leírással rendelkező paraméter hozzáadása a 'Paraméterek' részhez. |
| @Visszatérés | @return description | Kötelező minden olyan metódushoz, amely visszaad valamit (kivéve az érvénytelenséget) |
Használjuk a Javadoc címkét egy Java programban.
Számolja ki.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> Fordítsa le javac eszközzel:
Dokumentum létrehozása
Dokumentációs API létrehozása javadoc eszköz:
Most a HTML-fájlok létrejöttek a Kiszámítja osztály az aktuális könyvtárban, azaz abcDemo . Nyissa meg a HTML-fájlokat, és láthatjuk a Calculate class magyarázatát, amelyet a dokumentációs megjegyzésben adunk meg.
A Java megjegyzések végrehajthatók?
Évek: Mint tudjuk, a Java megjegyzéseket nem a fordító vagy az értelmező hajtja végre, azonban a kód lexikális átalakítása előtt a kód tartalmát ASCII-be kódolják a feldolgozás megkönnyítése érdekében.
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!!'); } } Kimenet:
A fenti kód generálja a kimenetet, mert a fordító elemzi a Unicode karaktert u000d mint a új sor a lexikális transzformáció előtt, és így a kód az alábbiak szerint alakul:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Így a Unicode karakter a print utasítást a következő sorba tolja, és normál Java kódként kerül végrehajtásra.