Hvad er Java-kom­men­ta­rer, og hvordan opretter man dem?

Der findes tre for­skel­li­ge typer kom­men­ta­rer i Java. Du kan bruge kom­men­ta­rer til at struk­tu­re­re og forklare din kode. En­kelt­linje­kom­men­ta­rer er til korte noter, mens blok­kom­men­ta­rer er velegnede til længere for­kla­rin­ger. Do­ku­men­ta­tions­kom­men­ta­rer er derimod om­fat­ten­de og tilbyder værdi ud over kil­de­ko­den.

Hvad er Java-kom­men­ta­rer?

At arbejde med kildekode kan nogle gange være pro­ble­ma­tisk, selv for erfarne udviklere. Afhængigt af projektet og dets omfang kan tingene hurtigt blive ufor­ud­si­ge­li­ge, og koden kan blive for­vir­ren­de. I sådanne si­tu­a­tio­ner er det måske ikke en god idé at arbejde alene med din kode. Men selvom du ønsker, at andre skal have adgang til din kode, er det ikke sikkert, at de intuitivt kan forstå den.

For at undgå mis­for­stå­el­ser og struk­tu­re­re koden mere over­sku­e­ligt giver Java brugerne mulighed for at skrive kom­men­ta­rer. Du kan bruge kom­men­ta­rer i dette pro­gram­me­rings­sprog til at forklare din tankegang, be­reg­nin­ger, metoder, klasser eller struk­tu­rer. Når du eller en anden senere ser på koden, vil kom­men­ta­rer­ne gøre det nemmere at arbejde med koden.

For at sikre, at kom­men­ta­rer er effektive, er det vigtigt at holde dem så korte som muligt. Samtidig skal de give læserne til­stræk­ke­lig in­for­ma­tion. Ved fejl­find­ing er vel­for­mu­le­re­de kom­men­ta­rer afgørende.

Java-kom­men­ta­rer findes i tre for­skel­li­ge versioner: en­kelt­linje­kom­men­ta­rer, blok­kom­men­ta­rer (fler­linje­kom­men­ta­rer) og do­ku­men­ta­tions­kom­men­ta­rer. Alle kom­men­ta­rer er markeret, så de ikke tages i be­tragt­ning ved kom­pi­le­ring. I de følgende afsnit viser vi dig, hvordan du opretter Java-kom­men­ta­rer, og hvornår du skal bruge hver enkelt type.

Hvilke typer kom­men­ta­rer findes der i Java?

Afhængigt af den type in­for­ma­tion, du ønsker at skrive, findes der tre for­skel­li­ge typer kom­men­ta­rer i Java. Disse er:

En­kelt­linje­kom­men­ta­rer

Dette er den enkleste kom­men­tar­mu­lig­hed. Denne type kommentar oprettes ved hjælp af to på hinanden følgende skrå­stre­ger (//) og må ikke være længere end en linje. Med en­kelt­linje­kom­men­ta­rer behøver du ikke angive et slutpunkt, da dette au­to­ma­tisk nås ved slut­nin­gen af linjen. Denne type Java-kom­men­ta­rer er velegnet til korte kom­men­ta­rer, der forklarer en funktion med få ord.

Fler­linje­de kom­men­ta­rer

Hvis dine for­kla­rin­ger skal være lidt længere, kan du bruge fler­linje­kom­men­ta­rer. Teoretisk set kan de være af enhver længde. De er velegnede til at inkludere al­ter­na­ti­ve ko­de­linjer, der er udelukket fra kom­pi­le­ring, eller til de­tal­je­re­de for­kla­rin­ger. Fler­linje­kom­men­ta­rer indledes med en skråstreg og en stjerne (/*). Når du når slut­nin­gen af kom­men­ta­ren, skal du blot skrive en stjerne ef­ter­fulgt af en skråstreg (*/). Teksten mellem den ind­le­den­de skråstreg og den af­slut­ten­de skråstreg behandles som en kommentar og tages ikke med i be­tragt­ning ved kom­pi­le­ring af koden.

Do­ku­men­ta­tions­kom­men­ta­rer

Mens en­kelt­linje­kom­men­ta­rer og fler­linje­kom­men­ta­rer teoretisk set kan indsættes hvor som helst i kil­de­ko­den, placeres do­ku­men­ta­tions­kom­men­ta­rer altid umid­del­bart før de klasser eller metoder, de beskriver. Ved hjælp af værktøjer læses disse kom­men­ta­rer op og sam­men­fat­tes i HTML-do­ku­men­ta­tion. De bruges primært til at oprette metadata for for­fat­te­re og visse typer parametre. Disse markeres med et @-symbol. Do­ku­men­ta­tions­kom­men­ta­rer indledes med en skråstreg og to stjerner (/**) og afsluttes med en stjerne og en skråstreg (*/).

En­kelt­linje­kom­men­ta­rer

For at forstå, hvordan Java-kom­men­ta­rer fungerer i praksis, vil vi se på et par enkle eksempler. Du kan selv prøve disse for at teste re­sul­ta­tet. En en­kelt­linje­kom­men­tar starter med to skrå­stre­ger og kan enten stå på sin egen linje eller placeres efter en række in­struk­tio­ner. **. Sådan ser kom­men­ta­ren ud på sin egen linje:

// Example of a single-line comment
class Main {
	public static void main(String[] args) {
	// Here is the comment
	System.out.println("This is the text that will be output at the end.");
	}
}

Hvis du bruger Java-kom­man­do­en System.out.println, vises kun sætningen “Dette er den tekst, der vises i slut­nin­gen”. De to kom­men­ta­rer vises kun i kil­de­ko­den.

Al­ter­na­tivt kan du placere kom­men­ta­ren direkte efter kom­man­do­en:

// Example of a single-line comment
class Main {
public static void main(String[] args) {
System.out.println("This is the text that is output at the end."); // This is the comment.
	}
}

Pla­ce­rin­gen af kom­men­ta­ren ændrer ikke det, der vises.

Fler­linje­de kom­men­ta­rer

Hvis du vil indsætte en fler­linje­kom­men­tar i din kode, kan du placere den før eller efter in­struk­tio­ner­ne i din kode. Fler­linje­kom­men­ta­rer indledes altid med en skråstreg og en stjerne. Her er en fler­linje­kom­men­tar før ko­de­in­struk­tio­ner­ne:

/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are under the comment.
This is the last line of this Java comment.
*/
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
	}
}

Outputtet lyder: “Dette er den tekst, der vil blive vist i slut­nin­gen.”

Sådan indsætter du kom­men­ta­ren under vej­led­nin­gen:

// Example of a multi-line comment below the instructions
class Main {
public static void main(String[] args) {
System.out.println("This is the text that will be output at the end.");
/* In this example there is a multi-line comment.
It starts after the asterisk.
The actual instructions for the computer are above the comment.
This is the last line of this Java comment. */
	}
}

Outputtet skal være det samme som i det fo­re­gå­en­de eksempel. Den en­kelt­linje­de kommentar i den første linje af ko­destyk­ket vil heller ikke blive vist. Du kan placere stjernen og skrå­stre­gen direkte efter kom­men­ta­ren eller bruge en separat linje.

Do­ku­men­ta­tions­kom­men­ta­rer

Do­ku­men­ta­tions­kom­men­ta­rer fungerer på samme måde som blok­kom­men­ta­rer, men indledes med en skråstreg og to stjerner. Dette gør det muligt for do­ku­men­ta­tions­værk­tø­jer at bruge kom­men­ta­rer­ne til at oprette do­ku­men­ta­tion. Om nød­ven­digt kan de også indeholde HTML-tags såsom <h1>, <p> eller <strong>.

Javadoc, et populært værktøj, som du kan bruge til at læse do­ku­men­ta­tions­kom­men­ta­rer, bruger også andre nyttige tags. Her er nogle af de vigtigste:

3a28aacd8cd906fd99226cbf9dfc8f12