Hva er Java-kommentarer og hvordan oppretter man dem?

Det finnes tre forskjellige typer kommentarer i Java. Du kan bruke kommentarer til å strukturere og forklare koden din. Enkelte linjekommentarer er for korte notater, mens blokkkommentarer er egnet for lengre forklaringer. Dokumentasjonskommentarer er derimot omfattende og gir verdi utover kildekoden.

Hva er Java-kommentarer?

Å jobbe med kildekode kan noen ganger være problematisk, selv for erfarne utviklere. Avhengig av prosjektet og omfanget, kan ting raskt bli uforutsigbare, og koden kan bli forvirrende. I slike situasjoner vil du kanskje ikke jobbe med koden alene. Men selv om du ønsker at andre skal ha tilgang til koden din, er det ikke sikkert at de vil kunne forstå den intuitivt.

For å unngå misforståelser og strukturere koden på en tydeligere måte, gir Java brukerne muligheten til å skrive kommentarer. Du kan bruke kommentarer i dette programmeringsspråket til å forklare tankeprosessen, beregninger, metoder, klasser eller strukturer. Når du eller noen andre ser på koden senere, vil kommentarene gjøre det enklere å jobbe med koden.

For å sikre at kommentarene er effektive, er det viktig å holde dem så korte som mulig. Samtidig bør de gi leserne tilstrekkelig informasjon. Ved feilsøking er velformulerte kommentarer avgjørende.

Java-kommentarer finnes i tre forskjellige versjoner: enkeltlinjekommentarer, blokkkommentarer (flerlinjekommentarer) og dokumentasjonskommentarer. Alle kommentarer er markert slik at de ikke tas med i beregningen ved kompilering. I de følgende avsnittene viser vi deg hvordan du oppretter Java-kommentarer og når du skal bruke hver av dem.

Hvilke typer kommentarer finnes det i Java?

Avhengig av hvilken type informasjon du ønsker å skrive, finnes det tre forskjellige typer kommentarer i Java. Disse er:

Enkelte linjekommentarer

Dette er den enkleste kommentarfunksjonen. Denne typen kommentarer opprettes ved hjelp av to påfølgende skråstreker (//) og kan ikke være lengre enn én linje. Med enkeltlinjekommentarer trenger du ikke å angi et sluttpunkt, siden dette nås automatisk ved slutten av linjen. Denne typen Java-kommentarer er egnet for korte kommentarer som forklarer en funksjon med få ord.

Flerlinjekommentarer

Hvis forklaringene dine må være litt lengre, kan du bruke flerlinjekommentarer. Teoretisk sett kan de være av hvilken som helst lengde. De er egnet for å inkludere alternative kodelinjer som er ekskludert fra kompilering eller for detaljerte forklaringer. Flerlinjekommentarer innledes med en skråstrek og en stjerne (/*). Når du kommer til slutten av kommentaren, trenger du bare å skrive en stjerne etterfulgt av en skråstrek (*/). Teksten mellom innledende skråstrek og avsluttende skråstrek behandles som en kommentar og tas ikke med i betraktningen når koden kompileres.

Dokumentasjonskommentarer

Mens enkeltlinjekommentarer og flerlinjekommentarer teoretisk sett kan settes inn hvor som helst i kildekoden, plasseres dokumentasjonskommentarer alltid rett før klassene eller metodene de beskriver. Ved hjelp av verktøy blir disse kommentarene lest ut og oppsummert i HTML-dokumentasjon. De brukes primært til å lage metadata for forfattere og visse typer parametere. Disse er merket med et @-symbol. Dokumentasjonskommentarer innledes med en skråstrek og to stjerner (/**) og avsluttes med en stjerne og en skråstrek (*/).

Enkelte linjekommentarer

For å forstå hvordan Java-kommentarer fungerer i praksis, skal vi se på noen enkle eksempler. Du kan prøve disse selv for å teste resultatet. En enkeltlinjekommentar starter med to skråstreker og kan enten stå på sin egen linje eller plasseres etter et sett med instruksjoner. **. Slik ser kommentaren ut 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 bruker Java-kommandoen System.out.println, vil bare setningen «Dette er teksten som vises på slutten» vises. De to kommentarene vil bare vises i kildekoden.

Alternativt kan du plassere kommentaren rett etter kommandoen:

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

Plasseringen av kommentaren endrer ikke utdataene.

Flerlinjekommentarer

Hvis du vil sette inn en flerlinjekommentar i koden din, kan du inkludere den før eller etter instruksjonene i koden. Flerlinjekommentarer innledes alltid med en skråstrek og en stjerne. Her er en flerlinjekommentar før kodeinstruksjonene:

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

Utdataene viser «Dette er teksten som vil bli vist på slutten.».

Slik setter du inn kommentaren under instruksjonene:

// 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 skal være det samme som i forrige eksempel. Enkelte linjekommentarer i første linje av kodebiten vil heller ikke vises. Du kan plassere stjernen og skråstreken rett etter kommentaren eller bruke en egen linje.

Dokumentasjonskommentarer

Dokumentasjonskommentarer fungerer på samme måte som blokkkommentarer, men innledes med en skråstrek og to stjerner. Dette gjør at dokumentasjonsverktøy kan bruke kommentarene til å lage dokumentasjon. Om nødvendig kan de også inneholde HTML-koder som <h1>, <p> eller <strong>.

Javadoc, et populært verktøy som du kan bruke til å lese dokumentasjonskommentarer, bruker også andre nyttige tagger. Her er noen av de viktigste:

939263ef5a1ac120c2d75264caf221db

7b0ed9d2883272aca77983e730a08231

ec9ac2b2b111a0659131bfc3f2231f91