logo

Java komentarai

The Java komentarai yra programos teiginiai, kurių nevykdo kompiliatorius ir interpretatorius.

Kodėl kode naudojame komentarus?

  • Komentarai naudojami tam, kad programa būtų lengviau skaitoma, pridedant išsamią kodo informaciją.
  • Tai leidžia lengvai prižiūrėti kodą ir lengvai rasti klaidas.
  • Komentarai gali būti naudojami teikiant informaciją ar paaiškinimą apie kintamasis , metodas, klasė , arba bet koks teiginys.
  • Jis taip pat gali būti naudojamas siekiant užkirsti kelią programos kodo vykdymui bandant alternatyvų kodą.

Java komentarų tipai

„Java“ yra trijų tipų komentarai.

  1. Vienos eilutės komentaras
  2. Kelių eilučių komentaras
  3. Dokumentacijos komentaras
Java komentarų tipai

1) Java vienos eilutės komentaras

Vienos eilutės komentaras naudojamas komentuoti tik vieną kodo eilutę. Tai yra plačiai naudojamas ir lengviausias būdas komentuoti teiginius.

Vienos eilutės komentarai prasideda dviem pasviraisiais brūkšniais (//) . Bet koks tekstas prieš // nėra vykdomas Java.

Sintaksė:

 //This is single line comment 

Naudokime vienos eilutės komentarą Java programoje.

KomentarasPavyzdys1.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 } } 

Išvestis:

 10 

2) Java kelių eilučių komentaras

Kelių eilučių komentaras naudojamas komentuoti kelias kodo eilutes. Jis gali būti naudojamas paaiškinti sudėtingą kodo fragmentą arba komentuoti kelias kodo eilutes vienu metu (nes ten bus sunku naudoti vienos eilutės komentarus).

Kelių eilučių komentarai dedami tarp /* ir */. „Java“ nevykdo jokio teksto tarp /* ir */.

Sintaksė:

java pridėti eilutę
 /* This is multi line comment */ 

Naudokime kelių eilučių komentarą Java programoje.

KomentarasPavyzdys2.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 ); */ } } 

Išvestis:

 10 

Pastaba: Paprastai // naudojamas trumpiems komentarams, o /* */ naudojamas ilgesniems komentarams.

3) Java dokumentacijos komentaras

Dokumentacijos komentarai paprastai naudojami rašant dideles projekto ar programinės įrangos programas, nes tai padeda sukurti dokumentacijos API. Šios API reikalingos nuorodai, t. y., kokios klasės, metodai, argumentai ir kt. naudojami kode.

Norėdami sukurti dokumentacijos API, turime naudoti javadoc įrankis . Dokumentų komentarai yra tarp /** ir */.

Sintaksė:

 /** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */ 

javadoc žymos

Kai kurios dokumentacijos komentaruose dažniausiai naudojamos žymos:

Žyma Sintaksė apibūdinimas
{@docRoot} {@docRoot} pavaizduoti santykinį kelią į sugeneruoto dokumento šakninį katalogą iš bet kurio puslapio.
@autorius @autoriaus vardas – tekstas Norėdami pridėti klasės autorių.
@kodas {@kodo tekstas} Norėdami rodyti tekstą kodo šriftu, neinterpretuojant jo kaip html žymėjimo arba įdėtos javadoc žymos.
@versija @version version-text Nurodyti paantraštę „Versija“ ir versijos tekstą, kai naudojama parinktis -version.
@nuo @nuo išleidimo Norėdami pridėti antraštę „Nuo“ su tekstu nuo tada prie sugeneruotos dokumentacijos.
@param @param parametro pavadinimo aprašymas Norėdami įtraukti parametrą su nurodytu pavadinimu ir aprašymu į skyrių 'Parametrai'.
@grįžti @grįžti aprašymas Reikalingas kiekvienam metodui, kuris kažką grąžina (išskyrus negaliojantį)

Naudokime Javadoc žymą Java programoje.

Apskaičiuokite.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(&apos;Addition of numbers: &apos; + result); } } </p>

Sukompiliuokite jį naudodami „Javac“ įrankį:

Sukurti dokumentą

java komentarai

Sukurti dokumentacijos API pagal javadoc įrankis:

java komentarai

Dabar HTML failai yra sukurti Apskaičiuoti klasė dabartiniame kataloge, t.y. abcDemo . Atidarykite HTML failus ir pamatysime Apskaičiuokite klasę, pateiktą dokumentacijos komentare.

Ar „Java“ komentarai yra vykdomi?

Metai: Kaip žinome, Java komentarų nevykdo kompiliatorius ar interpretatorius, tačiau prieš leksinę kodo transformaciją kompiliatoriuje kodo turinys užkoduojamas į ASCII, kad būtų lengviau apdoroti.

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println(&apos;Java comment is executed!!&apos;); } } 

Išvestis:

java komentarai

Aukščiau pateiktas kodas generuoja išvestį, nes kompiliatorius analizuoja Unicode simbolį u000d kaip nauja linija prieš leksinę transformaciją, taigi kodas transformuojamas taip, kaip parodyta žemiau:

Test.java

 public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println(&apos;Java comment is executed!!&apos;); } } 

Taigi, Unicode simbolis perkelia spausdinimo sakinį į kitą eilutę ir jis vykdomas kaip įprastas Java kodas.