Тхе Јава коментари су изјаве у програму које не извршавају компајлер и интерпретатор.
Зашто користимо коментаре у коду?
- Коментари се користе да би програм учинили читљивијим додавањем детаља кода.
- Олакшава одржавање кода и лако проналажење грешака.
- Коментари се могу користити за пружање информација или објашњења о променљива , метод, класа , или било коју изјаву.
- Такође се може користити за спречавање извршавања програмског кода током тестирања алтернативног кода.
Врсте Јава коментара
Постоје три врсте коментара у Јави.
- Коментар у једном реду
- Вишеструки коментар
- Документација Коментар
1) Јава једноредни коментар
Једноредни коментар се користи за коментарисање само једног реда кода. То је широко коришћен и најлакши начин коментарисања изјава.
Коментари у једном реду почињу са две косе црте (//) . Јава не извршава било који текст испред //.
Синтакса:
//This is single line comment
Хајде да користимо коментар у једном реду у Јава програму.
ЦомментЕкампле1.јава
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 } } Излаз:
10
2) Јава вишелинијски коментар
Вишелинијски коментар се користи за коментарисање више редова кода. Може се користити за објашњење сложеног исечка кода или за коментарисање више редова кода у исто време (пошто ће тамо бити тешко користити коментаре у једном реду).
Вишередни коментари се постављају између /* и */. Било који текст између /* и */ Јава не извршава.
Синтакса:
ислеттер јава
/* This is multi line comment */
Хајде да користимо вишелинијски коментар у Јава програму.
ЦомментЕкампле2.јава
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 ); */ } } Излаз:
10
Напомена: Обично се // користи за кратке коментаре, а /* */ се користи за дуже коментаре.
3) Коментар Јава документације
Документациони коментари се обично користе за писање великих програма за пројекат или софтверску апликацију јер помажу у креирању АПИ-ја за документацију. Ови АПИ-ји су потребни за референцу, тј. које класе, методе, аргументи итд. се користе у коду.
Да бисмо креирали документациони АПИ, морамо да користимо јавадоц алат . Коментари документације су смештени између /** и */.
Синтакса:
/** * *We can use various tags to depict the parameter *or heading or author name *We can also use HTML tags * */
јавадоц ознаке
Неке од најчешће коришћених ознака у коментарима документације:
| Таг | Синтакса | Опис |
|---|---|---|
| {@доцРоот} | {@доцРоот} | да прикаже релативну путању до основног директоријума генерисаног документа са било које странице. |
| @аутор | @име аутора - текст | Да бисте додали аутора класе. |
| @цоде | {@цоде тект} | За приказ текста у фонту кода без тумачења као хтмл ознаке или угнежђене јавадоц ознаке. |
| @версион | @верзија верзија-текст | Да бисте навели поднаслов 'Верзија' и текст верзије када се користи опција -версион. |
| @Од | @од објављивања | Да бисте у генерисану документацију додали наслов „Од“ са текстом од. |
| @парам | @парам опис имена-параметра | Да бисте додали параметар са датим именом и описом у одељку „Параметри“. |
| @ретурн | @ретурн десцриптион | Обавезно за сваки метод који нешто враћа (осим воид) |
Хајде да користимо Јавадоц ознаку у Јава програму.
Цалцулате.јава
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> Саставите га помоћу јавац алата:
Креирајте документ
Направите документациони АПИ од јавадоц оруђе:
Сада су ХТМЛ датотеке креиране за Израчунај класа у тренутном директоријуму, тј. абцДемо . Отворите ХТМЛ датотеке и можемо видети објашњење класе Цалцулате дато кроз коментар у документацији.
Да ли су Јава коментари извршни?
године: Као што знамо, Јава коментаре не извршава компајлер или тумач, међутим, пре лексичке трансформације кода у компајлеру, садржај кода се кодира у АСЦИИ како би се обрада олакшала.
Тест.јава
public class Test{ public static void main(String[] args) { //the below comment will be executed // u000d System.out.println('Java comment is executed!!'); } } Излаз:
Горњи код генерише излаз јер компајлер анализира Уницоде карактер у000д као Нова линија пре лексичке трансформације, и на тај начин се код трансформише као што је приказано у наставку:
Тест.јава
public class Test{ public static void main(String[] args) { //the below comment will be executed // System.out.println('Java comment is executed!!'); } } Дакле, Уницоде карактер помера наредбу за штампање у следећи ред и он се извршава као нормалан Јава код.