The Java kommentit ovat ohjelman lauseita, joita kääntäjä ja tulkki eivät suorita.
Miksi käytämme kommentteja koodissa?
- Kommentteja käytetään parantamaan ohjelman luettavuutta lisäämällä koodin tiedot.
- Sen avulla on helppo ylläpitää koodia ja löytää virheet helposti.
- Kommentteja voidaan käyttää antamaan tietoja tai selityksiä aiheesta muuttuja , menetelmä, luokkaa , tai mikä tahansa lausunto.
- Sitä voidaan käyttää myös estämään ohjelmakoodin suorittaminen testattaessa vaihtoehtoista koodia.
Java-kommenttien tyypit
Javassa on kolmenlaisia kommentteja.
- Yksirivinen kommentti
- Monirivinen kommentti
- Dokumentaatiokommentti
1) Java yksirivinen kommentti
Yksirivistä kommenttia käytetään kommentoimaan vain yhtä koodiriviä. Se on laajalti käytetty ja helpoin tapa kommentoida lausuntoja.
Yksiriviset kommentit alkavat kahdella vinoviivalla (//) . Java ei suorita mitään tekstiä // edessä.
Syntaksi:
//This is single line comment
Käytetään yksirivistä kommenttia Java-ohjelmassa.
KommenttiEsimerkki1.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 } }
Lähtö:
10
2) Java Multi Line -kommentti
Monirivistä kommenttia käytetään useiden koodirivien kommentoimiseen. Sitä voidaan käyttää selittämään monimutkainen koodinpätkä tai kommentoimaan useita koodirivejä kerrallaan (koska yksirivisten kommenttien käyttäminen siellä on vaikeaa).
Moniriviset kommentit sijoitetaan väliin /* ja */. Java ei suorita mitään tekstiä /* ja */ välillä.
Syntaksi:
gigatavun ja megatavun ero
/* This is multi line comment */
Käytetään Java-ohjelmassa monirivistä kommenttia.
KommenttiEsimerkki2.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 ); */ } }
Lähtö:
10
Huomautus: Yleensä // käytetään lyhyisiin kommentteihin ja /* */ pidempiin kommentteihin.
3) Java-dokumentaatiokommentti
Dokumentaatiokommentteja käytetään yleensä kirjoitettaessa suuria ohjelmia projektille tai ohjelmistosovellukselle, koska se auttaa luomaan dokumentaation sovellusliittymää. Näitä API:ita tarvitaan viitteeksi, eli mitä luokkia, menetelmiä, argumentteja jne. koodissa käytetään.
Dokumentaation API:n luomiseksi meidän on käytettävä javadoc työkalu . Dokumentaation kommentit sijoitetaan väliin /** ja */.
Syntaksi:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
javadoc-tunnisteet
Jotkut dokumentaation kommenteissa yleisesti käytetyistä tunnisteista:
Tag | Syntaksi | Kuvaus |
---|---|---|
{@docRoot} | {@docRoot} | kuvaamaan suhteellista polkua luodun asiakirjan juurihakemistoon miltä tahansa sivulta. |
@kirjoittaja | @tekijän nimi - teksti | Luokan kirjoittajan lisääminen. |
@koodi | {@kooditeksti} | Tekstin näyttäminen koodikirjasimella tulkitsematta sitä html-merkinnöiksi tai sisäkkäisiksi javadoc-tunnisteiksi. |
@versio | @version version-text | Määrittää 'Versio'-alaotsikon ja version-tekstin, kun -versio -vaihtoehtoa käytetään. |
@siitä asti kun | @julkaisusta lähtien | Voit lisätä luotuun dokumentaatioon 'Alkaen'-otsikon ja koska-teksti. |
@param | @param parametrin nimi kuvaus | Parametrin lisääminen annetulla nimellä ja kuvauksella Parametrit-osioon. |
@palata | @palautuskuvaus | Vaaditaan jokaiselle menetelmälle, joka palauttaa jotain (paitsi mitätön) |
Käytetään Javadoc-tunnistetta Java-ohjelmassa.
Laske.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>
Käännä se javac-työkalulla:
Luo asiakirja
Luo dokumentaatio-API by javadoc työkalu:
Nyt HTML-tiedostot on luotu Laskea luokka nykyisessä hakemistossa, eli abcDemo . Avaa HTML-tiedostot, niin näemme dokumentaation kommentin kautta selityksen Laske luokka.
Ovatko Java-kommentit suoritettavissa?
Vuodet: Kuten tiedämme, Java-kommentteja ei suorita kääntäjä tai tulkki, mutta ennen koodin leksikaalista muuntamista kääntäjässä koodin sisältö koodataan ASCII:ksi käsittelyn helpottamiseksi.
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!!'); } }
Lähtö:
Yllä oleva koodi tuottaa tulosteen, koska kääntäjä jäsentää Unicode-merkin u000d kuten a uusi rivi ennen leksikaalista muutosta, ja siten koodi muunnetaan alla olevan kuvan mukaisesti:
Test.java
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } }
Siten Unicode-merkki siirtää print-käskyn seuraavalle riville ja se suoritetaan tavallisena Java-koodina.