Vad är Java-kom­men­ta­rer och hur skapar man dem?

Det finns tre olika typer av kom­men­ta­rer i Java. Du kan använda kom­men­ta­rer för att struk­tu­re­ra och förklara din kod. Enradiga kom­men­ta­rer är avsedda för korta an­teck­ning­ar, medan block­kom­men­ta­rer är lämpliga för längre för­kla­ring­ar. Do­ku­men­ta­tions­kom­men­ta­rer är däremot om­fat­tan­de och erbjuder ett mervärde utöver källkoden.

Vad är Java-kom­men­ta­rer?

Att arbeta med källkod kan ibland vara pro­ble­ma­tiskt, även för erfarna ut­veck­la­re. Beroende på projektet och dess om­fatt­ning kan si­tu­a­tio­nen snabbt bli oför­ut­säg­bar och koden kan bli för­vir­ran­de. I sådana si­tu­a­tio­ner kanske du inte vill arbeta med koden på egen hand. Men även om du vill att andra ska kunna komma åt din kod kanske de inte kan förstå den intuitivt.

För att undvika miss­för­stånd och struk­tu­re­ra koden tydligare ger Java an­vän­dar­na möjlighet att skriva kom­men­ta­rer. Du kan använda kom­men­ta­rer i detta pro­gram­me­rings­språk för att förklara ditt tankesätt, be­räk­ning­ar, metoder, klasser eller struk­tu­rer. När du eller någon annan tittar på koden senare kommer kom­men­ta­rer­na att un­der­lät­ta arbetet med koden.

För att kom­men­ta­rer­na ska vara effektiva är det viktigt att de är så korta som möjligt. Samtidigt ska de ge läsarna till­räck­lig in­for­ma­tion. Vid fel­sök­ning är väl­for­mu­le­ra­de kom­men­ta­rer avgörande.

Java-kom­men­ta­rer finns i tre olika versioner: enradiga kom­men­ta­rer, block­kom­men­ta­rer (fler­ra­di­ga kom­men­ta­rer) och do­ku­men­ta­tions­kom­men­ta­rer. Alla kom­men­ta­rer markeras så att de inte beaktas vid kom­pi­le­ring. I följande avsnitt visar vi hur du skapar Java-kom­men­ta­rer och när du ska använda var och en av dem.

Vilka typer av kom­men­ta­rer finns det i Java?

Beroende på vilken typ av in­for­ma­tion du vill skriva finns det tre olika typer av kom­men­ta­rer till­gäng­li­ga i Java. Dessa är:

Enradiga kom­men­ta­rer

Detta är det enklaste kom­men­tarsal­ter­na­ti­vet. Denna typ av kommentar skapas med två på varandra följande sned­streck (//) och får inte vara längre än en rad. Med enradiga kom­men­ta­rer behöver du inte ange någon slutpunkt, eftersom denna nås au­to­ma­tiskt i slutet av raden. Denna typ av Java-kom­men­ta­rer är lämpliga för korta kom­men­ta­rer som förklarar en funktion med några få ord.

Fler­ra­di­ga kom­men­ta­rer

Om dina för­kla­ring­ar behöver vara lite längre kan du använda fler­ra­di­ga kom­men­ta­rer. Te­o­re­tiskt sett kan de vara hur långa som helst. De är lämpliga för att inkludera al­ter­na­ti­va kodrader som utesluts från kom­pi­le­ring eller för de­tal­je­ra­de för­kla­ring­ar. Fler­ra­di­ga kom­men­ta­rer inleds med ett sned­streck och en asterisk (/*). När du kommer till slutet av kom­men­ta­ren behöver du bara skriva en asterisk följt av ett sned­streck (*/). Texten mellan det inledande sned­strec­ket och det av­slu­tan­de sned­strec­ket behandlas som en kommentar och tas inte med i be­räk­ning­en när koden kom­pi­le­ras.

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

Medan enradiga och fler­ra­di­ga kom­men­ta­rer te­o­re­tiskt sett kan infogas var som helst i källkoden, placeras do­ku­men­ta­tions­kom­men­ta­rer alltid direkt före de klasser eller metoder som de beskriver. Med hjälp av verktyg läses dessa kom­men­ta­rer upp och sam­man­fat­tas i HTML-do­ku­men­ta­tion. De används främst för att skapa metadata för för­fat­ta­re och vissa typer av pa­ra­met­rar. Dessa markeras med ett @-tecken. Do­ku­men­ta­tions­kom­men­ta­rer inleds med ett sned­streck och två as­te­ris­ker (/**) och avslutas med en asterisk och ett sned­streck (*/).

Enradiga kom­men­ta­rer

För att förstå hur Java-kom­men­ta­rer fungerar i praktiken ska vi titta på några enkla exempel. Du kan prova dessa själv för att testa re­sul­ta­tet. En enradig kommentar börjar med två sned­streck och kan antingen stå på en egen rad eller placeras efter en upp­sätt­ning in­struk­tio­ner. **. Så här ser kom­men­ta­ren ut på en egen rad:

// 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.");
	}
}

Om du använder Java-kommandot System.out.println visas endast meningen ”Detta är texten som skrivs ut i slutet”. De två kom­men­ta­rer­na visas endast i källkoden.

Al­ter­na­tivt kan du placera kom­men­ta­ren direkt efter kommandot:

// 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­ring­en av kom­men­ta­ren ändrar inte vad som visas.

Fler­ra­di­ga kom­men­ta­rer

Om du vill infoga en flerradig kommentar i din kod kan du placera den före eller efter in­struk­tio­ner­na i koden. Fler­ra­di­ga kom­men­ta­rer inleds alltid med ett sned­streck och en asterisk. Här är en flerradig kommentar före kod­in­struk­tio­ner­na:

/* 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.");
	}
}

Ut­mat­ning­en lyder ”Detta är texten som kommer att matas ut i slutet.”.

Så här infogar du kom­men­ta­ren under in­struk­tio­ner­na:

// 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. */
	}
}

Re­sul­ta­tet bör bli detsamma som i fö­re­gå­en­de exempel. Enradiga kom­men­ta­rer i den första raden av ko­dav­snit­tet kommer inte heller att visas. Du kan placera as­te­ris­ken och sned­strec­ket direkt efter kom­men­ta­ren eller använda en separat rad.

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

Do­ku­men­ta­tions­kom­men­ta­rer fungerar på samma sätt som block­kom­men­ta­rer, men inleds med ett sned­streck och två as­te­ris­ker. Detta gör det möjligt för do­ku­men­ta­tions­verk­tyg att använda kom­men­ta­rer­na för att skapa do­ku­men­ta­tion. Vid behov kan de också innehålla HTML-taggar som <h1>, <p> eller <strong>.

Javadoc, ett populärt verktyg som du kan använda för att läsa do­ku­men­ta­tions­kom­men­ta­rer, använder också andra an­vänd­ba­ra taggar. Här är några av de vik­ti­gas­te: