Vad är Java-kommentarer och hur skapar man dem?

Det finns tre olika typer av kommentarer i Java. Du kan använda kommentarer för att strukturera och förklara din kod. Enradiga kommentarer är avsedda för korta anteckningar, medan blockkommentarer är lämpliga för längre förklaringar. Dokumentationskommentarer är däremot omfattande och erbjuder ett mervärde utöver källkoden.

Vad är Java-kommentarer?

Att arbeta med källkod kan ibland vara problematiskt, även för erfarna utvecklare. Beroende på projektet och dess omfattning kan situationen snabbt bli oförutsägbar och koden kan bli förvirrande. I sådana situationer 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 missförstånd och strukturera koden tydligare ger Java användarna möjlighet att skriva kommentarer. Du kan använda kommentarer i detta programmeringsspråk för att förklara ditt tankesätt, beräkningar, metoder, klasser eller strukturer. När du eller någon annan tittar på koden senare kommer kommentarerna att underlätta arbetet med koden.

För att kommentarerna ska vara effektiva är det viktigt att de är så korta som möjligt. Samtidigt ska de ge läsarna tillräcklig information. Vid felsökning är välformulerade kommentarer avgörande.

Java-kommentarer finns i tre olika versioner: enradiga kommentarer, blockkommentarer (flerradiga kommentarer) och dokumentationskommentarer. Alla kommentarer markeras så att de inte beaktas vid kompilering. I följande avsnitt visar vi hur du skapar Java-kommentarer och när du ska använda var och en av dem.

Vilka typer av kommentarer finns det i Java?

Beroende på vilken typ av information du vill skriva finns det tre olika typer av kommentarer tillgängliga i Java. Dessa är:

Enradiga kommentarer

Detta är det enklaste kommentarsalternativet. Denna typ av kommentar skapas med två på varandra följande snedstreck (//) och får inte vara längre än en rad. Med enradiga kommentarer behöver du inte ange någon slutpunkt, eftersom denna nås automatiskt i slutet av raden. Denna typ av Java-kommentarer är lämpliga för korta kommentarer som förklarar en funktion med några få ord.

Flerradiga kommentarer

Om dina förklaringar behöver vara lite längre kan du använda flerradiga kommentarer. Teoretiskt sett kan de vara hur långa som helst. De är lämpliga för att inkludera alternativa kodrader som utesluts från kompilering eller för detaljerade förklaringar. Flerradiga kommentarer inleds med ett snedstreck och en asterisk (/*). När du kommer till slutet av kommentaren behöver du bara skriva en asterisk följt av ett snedstreck (*/). Texten mellan det inledande snedstrecket och det avslutande snedstrecket behandlas som en kommentar och tas inte med i beräkningen när koden kompileras.

Dokumentationskommentarer

Medan enradiga och flerradiga kommentarer teoretiskt sett kan infogas var som helst i källkoden, placeras dokumentationskommentarer alltid direkt före de klasser eller metoder som de beskriver. Med hjälp av verktyg läses dessa kommentarer upp och sammanfattas i HTML-dokumentation. De används främst för att skapa metadata för författare och vissa typer av parametrar. Dessa markeras med ett @-tecken. Dokumentationskommentarer inleds med ett snedstreck och två asterisker (/**) och avslutas med en asterisk och ett snedstreck (*/).

Enradiga kommentarer

För att förstå hur Java-kommentarer fungerar i praktiken ska vi titta på några enkla exempel. Du kan prova dessa själv för att testa resultatet. En enradig kommentar börjar med två snedstreck och kan antingen stå på en egen rad eller placeras efter en uppsättning instruktioner. **. Så här ser kommentaren 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å kommentarerna visas endast i källkoden.

Alternativt kan du placera kommentaren 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.
	}
}

Placeringen av kommentaren ändrar inte vad som visas.

Flerradiga kommentarer

Om du vill infoga en flerradig kommentar i din kod kan du placera den före eller efter instruktionerna i koden. Flerradiga kommentarer inleds alltid med ett snedstreck och en asterisk. Här är en flerradig kommentar före kodinstruktionerna:

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

Utmatningen lyder ”Detta är texten som kommer att matas ut i slutet.”.

Så här infogar du kommentaren under instruktionerna:

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

Resultatet bör bli detsamma som i föregående exempel. Enradiga kommentarer i den första raden av kodavsnittet kommer inte heller att visas. Du kan placera asterisken och snedstrecket direkt efter kommentaren eller använda en separat rad.

Dokumentationskommentarer

Dokumentationskommentarer fungerar på samma sätt som blockkommentarer, men inleds med ett snedstreck och två asterisker. Detta gör det möjligt för dokumentationsverktyg att använda kommentarerna för att skapa dokumentation. 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 dokumentationskommentarer, använder också andra användbara taggar. Här är några av de viktigaste: