TechCodeview

The Jawa komentarze to instrukcje w programie, które nie są wykonywane przez kompilator i interpreter.

Dlaczego używamy komentarzy w kodzie?

• Komentarze służą poprawie czytelności programu poprzez dodanie szczegółów kodu.
• Ułatwia to utrzymanie kodu i łatwe znajdowanie błędów.
• Komentarze mogą służyć do przekazywania informacji lub wyjaśnień na temat zmienny , metoda, klasa lub dowolne oświadczenie.
• Można go również użyć, aby uniemożliwić wykonanie kodu programu podczas testowania kodu alternatywnego.

Rodzaje komentarzy Java

W Javie istnieją trzy typy komentarzy.

1. Komentarz jednowierszowy
2. Komentarz wielowierszowy
3. Komentarz do dokumentacji

1) Komentarz jednoliniowy Java

Komentarz jednowierszowy służy do komentowania tylko jednej linii kodu. Jest to najpowszechniej stosowany i najłatwiejszy sposób komentowania wypowiedzi.

Komentarze jednoliniowe zaczynają się od dwóch ukośników (//) . Żaden tekst przed // nie jest wykonywany przez Javę.

Składnia:

 //This is single line comment 

Użyjmy komentarza jednowierszowego w programie Java.

KomentarzPrzykład1.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 } } 

Wyjście:

 10 

2) Komentarz wielowierszowy Java

Komentarz wielowierszowy służy do komentowania wielu wierszy kodu. Można go użyć do wyjaśnienia złożonego fragmentu kodu lub do skomentowania wielu linii kodu na raz (ponieważ trudno będzie tam użyć komentarzy jednowierszowych).

Komentarze wieloliniowe umieszczane są pomiędzy /* i */. Żaden tekst pomiędzy /* i */ nie jest wykonywany przez Javę.

Składnia:

zmiana nazwy katalogu

 /* This is multi line comment */ 

Użyjmy komentarza wielowierszowego w programie Java.

KomentarzPrzykład2.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 ); */ } } 

Wyjście:

 10 

Uwaga: Zwykle // jest używane do krótkich komentarzy, a /* */ do dłuższych komentarzy.

3) Komentarz do dokumentacji Java

Komentarze do dokumentacji są zwykle używane do pisania dużych programów dla projektu lub aplikacji, ponieważ pomagają w tworzeniu interfejsu API dokumentacji. Te interfejsy API są potrzebne do odniesienia, tj. tego, które klasy, metody, argumenty itp. są używane w kodzie.

Aby utworzyć API dokumentacji, musimy skorzystać z narzędzie javadoc . Komentarze do dokumentacji znajdują się pomiędzy /** i */.

Składnia:

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

tagi javadoc

Niektóre z powszechnie używanych tagów w komentarzach do dokumentacji:

Użyjmy tagu Javadoc w programie Java.

Oblicz.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>

Skompiluj go za pomocą narzędzia javac:

Utwórz dokument

Utwórz dokumentację API według javadoc narzędzie:

Teraz tworzone są pliki HTML dla Oblicz class w bieżącym katalogu, tj. abcDemo . Otwórz pliki HTML, a w komentarzu do dokumentacji możemy zobaczyć wyjaśnienie klasy Calculate.

Czy komentarze Java są wykonywalne?

Lata: Jak wiemy, komentarze w Javie nie są wykonywane przez kompilator ani interpreter, jednak przed leksykalną transformacją kodu w kompilatorze zawartość kodu jest kodowana w formacie ASCII, aby ułatwić przetwarzanie.

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!!'); } } 

Wyjście:

Powyższy kod generuje dane wyjściowe, ponieważ kompilator analizuje znak Unicode u000d jak Nowa linia przed transformacją leksykalną i tym samym kod ulega transformacji w sposób pokazany poniżej:

Test.java

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

Zatem znak Unicode przesuwa instrukcję print do następnej linii i jest wykonywana jak normalny kod Java.