Hur man använder kommentarer i Java-kod

Java-kommentarer är anteckningar i en Java-kodfil som ignoreras av kompilatorn och körtiden. De används för att kommentera koden för att klargöra dess utformning och syfte. Du kan lägga till ett obegränsat antal kommentarer till en Java-fil, men det finns några "bästa metoder" att följa när du använder kommentarer.

Generellt är kodkommentarer "implementerings" -kommentarer som förklarar källkod, såsom beskrivningar av klasser, gränssnitt, metoder och fält. Dessa är vanligtvis ett par rader skrivna ovanför eller bredvid Java-kod för att klargöra vad den gör.

En annan typ av Java-kommentar är en Javadoc-kommentar. Javadoc-kommentarer skiljer sig något i syntax från implementeringskommentarer och används av programmet javadoc.exe för att generera Java HTML-dokumentation.

Varför använda Java-kommentarer?

Det är bra att använda vanan att lägga Java-kommentarer i din källkod för att förbättra dess läsbarhet och tydlighet för dig själv och andra programmerare. Det är inte alltid direkt klart vad ett avsnitt av Java-koden utför. Några förklarande rader kan drastiskt minska den tid det tar att förstå koden.

instagram viewer

Påverkar de hur programmet körs?

Implementeringskommentarer i Java-kod är bara där för människor att läsa. Java-kompilatorer bryr sig inte om dem och när sammanställa programmet, de hoppar bara över dem. Storleken och effektiviteten på ditt sammanställda program påverkas inte av antalet kommentarer i din källkod.

Implementeringskommentarer

Implementeringskommentarer finns i två olika format:

Linjekommentarer: För en kommentar på en rad skriver du "//" och följer de två snedstreck med din kommentar. Till exempel:
```
 // detta är en enda radkommentar
int guessNumber = (int) (Math.random () * 10); 
```
När kompilatorn stöter på de två framåtriktade snedstreckarna vet den att allt till höger om dem ska betraktas som en kommentar. Detta är användbart när du felsöker en kod. Lägg bara till en kommentar från en kodrad du felsöker, och kompilatorn ser inte den:
- ```
 // detta är en enda radkommentar
// int guessNumber = (int) (Math.random () * 10); 
```
  Du kan också använda de två snedstreckarna för att göra en kommentar i slutet av raden:
- ```
 // detta är en enda radkommentar
int guessNumber = (int) (Math.random () * 10); // En ände av linjen kommentar 
```
Blockera kommentarer: Om du vill starta en blockkommentar skriver du "/ *". Allt mellan snedstreck och asterisk, även om det är på en annan linje, behandlas som en kommentar tills tecknen "* /" avsluta kommentaren. Till exempel:
```
 / * detta 
är 
en
blockera
kommentar
*/
/ * så är detta * /
```

Javadoc kommentarer

Använd speciella Javadoc-kommentarer för att dokumentera ditt Java API. Javadoc är ett verktyg som ingår i JDK som genererar HTML-dokumentation från kommentarer i källkoden.

En Javadoc-kommentar i

.java

källfiler är bifogade i start- och slutsyntax så:

/**

och

*/

. Varje kommentar inom dessa förordas med en

Placera dessa kommentarer direkt ovanför metoden, klassen, konstruktören eller något annat Java-element som du vill dokumentera. Till exempel:

// myClass.java
/**
* Gör detta till en sammanfattande mening som beskriver din klass.
* Här är en annan linje.
*/
offentligklass min klass
{
...
}

Javadoc innehåller olika taggar som styr hur dokumentationen genereras. Till exempel

@param

tag definierar parametrar för en metod:

 / ** huvudmetod
* @param args String []
*/
offentligstatisktomhet main (String [] args)
{
System.out.println ("Hej världen!");
}

Många andra taggar finns tillgängliga i Javadoc, och det stöder också HTML-taggar för att kontrollera utgången. Se din Java-dokumentation för mer information.

Tips för användning av kommentarer

Kommentera inte över. Varje rad i ditt program behöver inte förklaras. Om ditt program flyter logiskt och inget oväntat inträffar känner du inte behovet av att lägga till en kommentar.
Intryck dina kommentarer. Om koden som du kommenterar är indragd, se till att din kommentar matchar intrycket.
Håll kommentarerna relevanta. Vissa programmerare är utmärkta på att ändra kod, men glöm av någon anledning att uppdatera kommentarerna. Om en kommentar inte längre gäller, ändra eller ta bort den.

Häck inte kommentarer. Följande kommer att resultera i ett kompilatorfel:

 / * detta 
är
/ * Den här blockkommentaren slutför den första kommentaren * /
en
blockera
kommentar
*/