Hvordan kommentere i Java?

Kommandoer er veldig viktige i dataprogrammering. Dette er enkle forklaringer på kildekoden som gjør kildekoden mer forståelig for mennesker. Disse blir imidlertid ikke vurdert av kompilatoren eller tolken.

Viktigheten av kommentarer

Som diskutert ovenfor, er kommentarer nødvendige fordi de gjør et dataprogram mer forståelig. Fordeler med kommentarer er listet opp nedenfor.

• Gjør koden enkel å lese.
• Uanstrengt kodevedlikehold og feildeteksjon.
• Gi detaljer om en viss metode, klasse, variabel eller uttalelse.
• Funksjoner skrevet for bruk av andre blir lettere å forstå.

Som på andre programmeringsspråk kan du også skrive kommentarer i Java. Denne oppskrivningen utforsker forskjellige typer Java-kommentarer og hvordan du bruker dem sammen med eksemplene deres.

Typer java -kommentarer

I Java er det tre tilnærminger å kommentere som vist nedenfor.

Enkeltlinjekommentar

For å kommentere en enkelt linjekommentarer brukes enkeltlinjekommentarer som begynner med to fremover skråstreker. Tekst skrevet etter disse fremre skråstrekene blir ignorert av Java -kompilatoren.

Her er syntaksen til Java-en-linje kommentar:

// dette er en enkeltlinje kommentar

Eksempel

Multi-linje kommentar

Når du vil kommentere flere linjer i Java-kildekoden. Det begynner med / * og slutter med * /. Tekst skrevet mellom disse vil ikke bli utført av Java -kompilatoren.

Syntaks

/ * Dette er en multi-linjekommentar */

Eksempel

Dokumentasjonskommentar

Dokumentasjonskommentarer brukes vanligvis til å lage dokumentasjons -API for større Java -programmer. Disse dokumentasjons -APIene brukes til å referere til klasser, metoder og argumenter som brukes i kildekoden. Det begynner med /** og slutter med* /.

Her er syntaks for dokumentasjonstype kommentar i Java.

/**
*
*For å skildre parametere bruker vi forskjellige tagger
*eller metode eller overskrift
*Eller vi kan bruke HTML -tagger
*
*/

Eksempel

Tabell gitt nedenfor dekker flere typer Javadoc -tagger.

Tagnavn	Syntaks	Beskrivelse
@forfatter	@Author Name-Text	Det brukes til å skrive forfatternavnet til en bestemt klasse.
@versjon	@Version versjon-text	Det brukes til å nevne versjonstekst.
@param	@param-parameter navnbeskrivelse	Det brukes til å legge til parameternavn og beskrivelse.
@komme tilbake	@return beskrivelse	Det brukes til å finne returverdiene enkelt ved å lage en "retur" -del.
@deprecated	@deprecated utdatert tekst	Det brukes til indikasjon på en utdatert klasse eller metode eller arkivert og oppretter en advarsel hver gang den brukes av noen.
@siden	@since Release	Den brukes til å spesifisere versjonen av metoden eller klassen osv. Ved å legge til "siden" -delen.
@Trows	@Trows Class-Name Beskrivelse	Det brukes til å kaste et unntak.
@unntak	@Exception Class-Name Beskrivelse	Den har en lignende bruk som @TROW -taggen.
@se	@see Reference	Det brukes til å legge til en referanse til en metode eller klasse ved å generere en lenke i delen "Se også".
@serial	@Serial feltbeskrivelse | inkluderer | utelukke	Det brukes til å legge til relevant informasjon om serialiserte felt.
@serialfield	@Serial Field-Name Field-type feltbeskrivelse	Det brukes til å dokumentere ObjectStreamField -komponenten.
@SerialData	@SerialData Data-beskrivelse	Det brukes til å dokumentere data skrevet etter metoder som WritObject () eller Writeexternal ().
@docroot	@docroot	Det brukes til å vise rotkatalogsti.
@kode	@code tekst	Den brukes til å vise tekst i kodefonter.
@verdi	@value -pakke.Klasse#felt	Den brukes til å vise verdien av konstanten når en DOC -kommentar er skrevet i et statisk felt.
@inheritdoc	-	Det brukes til å arve en kommentar fra en arvelig klasse.
@link	@link -pakke.Klasse#medlemsetikett	Den inkluderer en lenke som fokuserer dokumentasjonen for en bestemt pakke, klasse eller medlemsnavn på en klasse som er referert.
@linkplain	@linkplain -pakke.Klasse#medlemsetikett	Ligner på Link med den eneste forskjellen som etiketten til lenken vises i ren tekst i stedet for kodetekst.

Konklusjon

Det er tre typer kommentarer i Java. Den første er en enkeltlinjekommentar som begynner med to fremre skråstreker '//', den andre er en multi-line kommentar som begynner med/ * og slutter med */, mens den siste er en dokumentasjonskommentar som brukes til å opprette Dokumentasjon API for store Java -programmer og applikasjoner. Alle disse kommentarene er forklart i denne opplæringen sammen med Javadoc -tagger som brukes i dokumentasjonskommentarer.