Как да използвате коментари в Java Code

Коментарите на Java са бележки във файл с код на Java, които се игнорират от съставителя и машината за изпълнение. Те се използват за поясняване на кода, за да се изясни неговият дизайн и предназначение. Можете да добавите неограничен брой коментари към Java файл, но има някои "най-добри практики", които трябва да следвате, когато използвате коментари.

Като цяло, кодовите коментари са коментари за "изпълнение", които обясняват програмен код, като описания на класове, интерфейси, методи и полета. Това обикновено са няколко реда, написани по-горе или до Java код, за да се изясни какво прави.

Друг вид коментар на Java е коментар на Javadoc. Коментарите на Javadoc се различават леко по синтаксис от коментарите за изпълнение и се използват от програмата javadoc.exe за генериране на Java HTML документация.

Защо да използвате Java коментари?

Добра практика е да влезете в навика да поставяте коментари на Java във вашия изходен код, за да подобрите нейната четимост и яснота за себе си и други програмисти. Не винаги е ясно веднага какво изпълнява раздел от Java кода. Няколко обяснителни реда могат драстично да намалят времето, необходимо за разбиране на кода.

instagram viewer

Засягат ли те как функционира програмата?

Коментари за изпълнение във Java код има само хора, които могат да четат. Java компилаторите не ги интересуват и кога съставяне на програмата, те просто прескачат над тях. Размерът и ефективността на вашата компилирана програма няма да се повлияят от броя на коментарите във вашия изходен код.

Коментари за изпълнение

Коментарите за изпълнение се предлагат в два различни формата:

Коментари към реда: За коментар от един ред напишете "//" и следвайте двете предни наклонени черти с вашия коментар. Например:
```
 // това е един ред коментар
int предположениеNumber = (int) (Math.random () * 10); 
```
Когато компилаторът се натъкне на двете предни наклонени черти, той знае, че всичко вдясно от тях трябва да се разглежда като коментар. Това е полезно при отстраняване на грешки на код. Просто добавете коментар от ред код, който отстранявате, и компилаторът няма да го види:
- ```
 // това е един ред коментар
// int предположениеNumber = (int) (Math.random () * 10); 
```
  Можете също да използвате двете предни наклонени черти, за да направите коментар в края на реда:
- ```
 // това е един ред коментар
int предположениеNumber = (int) (Math.random () * 10); // Коментар в края на реда 
```
Блокиране на коментари: За да стартирате блоков коментар, въведете "/ *". Всичко между наклонена черта и звездичка, дори ако е на различна линия, се третира като коментар, докато героите "* /" приключат коментара. Например:
```
 /* това 
е 
а
блок
коментар
*/
/ * така е и това * /
```

Javadoc Коментари

Използвайте специални коментари на Javadoc, за да документирате вашия Java API. Javadoc е инструмент, включен в JDK, който генерира HTML документация от коментари в изходния код.

Коментар на Javadoc в

.java

изходните файлове са затворени в началния и крайния синтаксис така:

/**

*/

. Всеки коментар в тях е с а

Поставете тези коментари директно над метода, класа, конструктора или всеки друг Java елемент, който искате да документирате. Например:

// myClass.java
/**
* Направете това обобщено изречение, описващо вашия клас.
* Ето още един ред.
*/
общественклас Моят клас
{
...
}

Javadoc включва различни тагове, които контролират как се генерира документацията. Например, the

@param

tag определя параметрите на метод:

 / ** основен метод
* @param args String []
*/
общественстатиченпразнота main (String [] args)
{
System.out.println ("Здравей, свят!");
}

Много други тагове са достъпни в Javadoc, а също така поддържа HTML маркери, за да помогне за контролиране на изхода. Вижте вашата документация за Java за повече подробности.

Съвети за използване на коментари

Не прекалявайте с коментар Всеки ред от вашата програма не е необходимо да се обяснява. Ако вашата програма протича логично и не се случва нищо неочаквано, не изпитвайте нужда да добавяте коментар.
Въведете коментарите си. Ако редът на кода, който коментирате, е отстъпен, уверете се, че вашият коментар съвпада с отстъпа.
Поддържайте коментарите подходящи. Някои програмисти са отлични в промяната на кода, но по някаква причина забравете да актуализирате коментарите. Ако коментар вече не се прилага, го модифицирайте или премахнете.

Не пускайте коментари в блока. Следното ще доведе до грешка в компилатора:

 /* това 
е
/ * Този блоков коментар завършва първия коментар * /
а
блок
коментар
*/