Sådan bruges kommentarer i Java-kode

Java-kommentarer er noter i en Java-kodefil, der ignoreres af kompilatoren og runtime-motoren. De bruges til at kommentere koden for at tydeliggøre dens design og formål. Du kan tilføje et ubegrænset antal kommentarer til en Java-fil, men der er nogle "bedste fremgangsmåder", der skal følges, når du bruger kommentarer.

Generelt er kodekommentarer "implementerings" -kommentarer, der forklarer kildekode, såsom beskrivelser af klasser, grænseflader, metoder og felter. Dette er normalt et par linjer skrevet ovenfor eller ved siden af Java-kode for at afklare, hvad den gør.

En anden type Java-kommentar er en Javadoc-kommentar. Javadoc-kommentarer adskiller sig lidt i syntaks fra implementeringskommentarer og bruges af programmet javadoc.exe til at generere Java HTML-dokumentation.

Hvorfor bruge Java-kommentarer?

Det er god praksis at komme ind i vanen med at sætte Java-kommentarer i din kildekode for at forbedre dens læsbarhed og klarhed for dig selv og andre programmerere. Det er ikke altid med det samme klart, hvad et afsnit af Java-kode udfører. Et par forklarende linjer kan drastisk reducere den tid det tager at forstå koden.

instagram viewer

Påvirker de, hvordan programmet kører?

Gennemførelseskommentarer i Java-kode er kun der for mennesker at læse. Java-compilere er ligeglad med dem, og hvornår kompilering af programmet, springer de bare over dem. Størrelsen og effektiviteten af dit kompilerede program påvirkes ikke af antallet af kommentarer i din kildekode.

Implementeringskommentarer

Implementeringskommentarer findes i to forskellige formater:

Linjekommentarer: For en kommentar på en linje skal du skrive "//" og følge de to skråstreg med din kommentar. For eksempel:
```
 // dette er en enkelt linje kommentar
int gætNummer = (int) (Math.random () * 10); 
```
Når kompilatoren støder på de to forreste skråstreg, ved den, at alt til højre for dem skal betragtes som en kommentar. Dette er nyttigt, når du fejlsøger et stykke kode. Bare tilføj en kommentar fra en kodelinje, du debugger, og kompilatoren ser den ikke:
- ```
 // dette er en enkelt linje kommentar
// int guessNumber = (int) (Math.random () * 10); 
```
  Du kan også bruge de to skråstreg for at afslutte en kommentar til linjen:
- ```
 // dette er en enkelt linje kommentar
int gætNummer = (int) (Math.random () * 10); // En slutkommentar 
```
Bloker kommentarer: Skriv "/ *" for at starte en blokkommentar. Alt mellem det skråstreg og stjerne, selvom det er på en anden linje, behandles som en kommentar, indtil tegnene "* /" afslutter kommentaren. For eksempel:
```
 /* dette 
er 
-en
blok
kommentar
*/
/ * så er dette * /
```

Javadoc kommentarer

Brug specielle Javadoc-kommentarer til at dokumentere dit Java API. Javadoc er et værktøj inkluderet i JDK, der genererer HTML-dokumentation fra kommentarer i kildekoden.

En Javadoc-kommentar i

.java

kilde filer er lukket i start og slut syntaks som sådan:

/**

*/

. Hver kommentar inden for disse er prævaleret med en

Placer disse kommentarer direkte over metoden, klassen, konstruktøren eller ethvert andet Java-element, du vil dokumentere. For eksempel:

// myClass.java
/**
* Lav dette til en oversigtssætning, der beskriver din klasse.
* Her er en anden linje.
*/
offentligklasse min klasse
{
...
}

Javadoc indeholder forskellige tags, der kontrollerer, hvordan dokumentationen genereres. F.eks

@ param

tag definerer parametre til en metode:

 / ** hovedmetode
* @param args String []
*/
offentligstatiskugyldig main (streng [] args)
{
System.out.println ("Hej verden!");
}

Mange andre tags er tilgængelige i Javadoc, og det understøtter også HTML-tags for at hjælpe med at kontrollere output. Se din Java-dokumentation for flere detaljer.

Tip til brug af kommentarer

Kommenter ikke for meget. Hver linje i dit program behøver ikke at blive forklaret. Hvis dit program flyder logisk, og der ikke sker noget uventet, skal du ikke føle behov for at tilføje en kommentar.
Indryk dine kommentarer. Hvis den kodelinje, du kommenterer, er indrykket, skal du sørge for, at din kommentar stemmer overens med indrykket.
Hold kommentarer relevante. Nogle programmerere er fremragende til at ændre kode, men glem af en eller anden grund at opdatere kommentarerne. Hvis en kommentar ikke længere gælder, skal du enten ændre eller fjerne den.

Bloker ikke kommentarer. Følgende vil resultere i en compiler-fejl:

 /* dette 
er
/ * Denne blokkommentar afslutter den første kommentar * /
-en
blok
kommentar
*/