Hvordan skriver du en javadokkommentar?

“Kommentarer spiller en veldig viktig rolle i ens liv, jeg.e., for å få dem til å oppgradere livsstilen sin og alt relatert. Det er hovedsakelig to typer kommentarer, jeg.e., Enkeltlinje kommentarer og multi-linjekommentarer. Men det er en annen type kommentar som vi vanligvis ikke lærer, jeg.e., Javadoc kommenterer. Javadoc -kommentarene er vanligvis kjent blant Java -utviklere og kan genereres av programmets JDK automatisk, og du trenger ikke å lage dine kommentarer. Et program kalt Javadoc er inkludert i JDK og er ansatt for å generere en HTML -beskrivelse av Java -kode via Java Language Source, som krever dokumentasjon på en forhåndsbestemt måte. I denne opplæringen vil du se på Javadoc -kommentarene i Java -programmering ved hjelp av Java -verktøyet i Windows -systemet.”

Syntaks

For det første må vi se den grunnleggende syntaksen til Javadoc -kommentarer i Java. Så vi har brukt Simple Editor for å legge noen Javadoc -kommentarer i den og vise presentasjonen av den nedenfor på bildet vedlagt. Den autogenererte kommentaren til Java -dokumentet starter med en spesiell karakter som en stjerne, og hele kommentarens første linje kan være grønn farge. Du kan se skildringen av en Java -dokumentkommentar som har mange stjernefigurer i starten av hver kommentar fra start til slutt.

I starten starter Java Doc -kommentaren med "//" -tegnet etterfulgt av to stjernefigurer. Samtidig inneholder alle de andre linjene en enkelt stjerne karakter ved starten av. På slutten av en Java -dokumentkommentar har vi avsluttet den med "/" -karakteren. I mellom denne Java -dokumentets kommentarillustrasjon, vil du se en kommentarlinje “7” der vi har definert navnet på en forfatter som bruker “@” -tegnet for å definere en variabel “forfatter” med navnet på en kommentarforfatter, i.e., Saeed Raza. Metadatainformasjonen om Java-dokumentkommentarer må alltid skrives med "@" -karakteren.

Lag automatisk Java Doc -kommentar i Eclipse Ide

Dette eksemplet bruker Eclipse IDE Java Development Environment for å lage automatiske kommentarer i Java -prosjektet. For dette må du ha en Eclipse IDE montert og satt opp på slutten. Så start Eclipse IDE og prøv å lage et nytt prosjekt som heter “Java”. Det vil be deg om å navngi den nåværende prosjektpakken. Vi kalte det også "Java". Etter det må du opprette en ny Java -fil eller opprette en ny klasse i samme Java -prosjekt. For dette, høyre-TAP på pakningsnavnet fra venstre hjørne av Eclipse IDE Project Explorer Bar, flytt til “Nye” alternativet og treffer nøkkelordet “Klasse” fra de utvidede alternativene. Dette vil generere et nytt vindu på skjermen din med tittelen "New Java Class", som vist på bildet nedenfor.

Nå må du sette inn navnet på en klasse som skal opprettes i tekstboksen foran "Navn" -etiketten. De fleste tingene vil bli uendret, da disse ble valgt automatisk når du prøver å opprette en ny klasse. Du trenger bare å tømme metoden du vil opprette for din Java -kode. Derfor har vi sjekket den første avmerkingsboksen for å opprette en hovedfunksjon () driver i denne klassen. Sist, men ikke minst, vil du finne en mulighet til å legge til standardkommentarer i Java -programmet som skal opprettes. Du trenger bare å merke av for avkrysningsruten som heter “Generere kommentarer”. Dette kommer til å være et fenomenalt trinn i opprettelsen av Java -kode. La oss trykke på "Fullfør" -knappen etter å ha gitt all nødvendig informasjon.

Det vist-below Java-programmet ble opprettet i Eclipse IDE-verktøyet sammen med automatiske kommentarer. Du kan se at Java Doc -kommentarene startet med stjernefigurene. Det gir også metadatainformasjon angående prosjektet, i.e., forfatteren. Sammen med det viser den også at autokommentaren skildrer at vi også har laget en stubbens hovedfunksjon. Det handler om den automatiske generasjonen av Javadoc -kommentarer i Eclipse IDE.

Eksempel 01: Javadoc -kommentarer

Nå kan du lage dine egne Java -dokumentkommentarer mens du koder. Her er en annen illustrasjon for å gjøre det. Hver gang du har brukt Main () driverfunksjonen i koden, i.e., Du burde ha brukt det i hvert eneste program, du skal alltid opprette kommentaren øverst i filen, eller innenfor denne funksjonen, begynne som “// TODO Auto-Generated Method Stub”. Denne kommentaren forklarer at Main () -metoden er generert automatisk, i.e., Du trenger ikke å skrive det.

Etter dette har vi lagt til en Javadoc Long-kommentar som utdyper bruken av dette programmet sammen med sin metadatainformasjon, i.e., forfatter, versjon og datoen den ble opprettet. Før "Println" -uttalelsen er det en enkelt kommentarlinje som brukes til å forklare formålet med å bruke println () -funksjonen. Det er det for dette eksemplet.

Utførelsen av programmer med kommentarer påvirker ikke utdataene som nedenfor.

Eksempel 01: Enkeltlinje og multiline kommentarer

Etter å ha gått gjennom Javadoc-kommentarene i Eclipse IDE, la oss begynne å ta en titt på et annet eksempel på Java ved å bruke enkeltlinjen og multi-line kommentarer, jeg.e., brukerdefinert. Vi genererte nå en ny klasse "test" og inkluderte Main () -metoden i den. Denne metoden har en println () funksjonserklæring for å vise noe. Vi har brukt en enkeltlinjekommentar med navnet på en klasse som starter med “//” -tegn, jeg.e., forklarer at det er klasseinitialisering. På hoveddefinisjonslinjen Main () la definisjonen en multi-linjekommentar som starter med “/*” -tegnene og endte med “*/” -tegn.

Konklusjon

Denne artikkelen hjelper deg å forstå viktigheten og vitaliteten til kommentarer som brukes i dagliglivet og programmeringslivet. Den diskuterer hvordan disse kommentarene kan hjelpe deg på mange måter. For det første diskuterte vi hva som er Javadoc -kommentarene og forklarte syntaksen deres veldig kort. Etter dette forklarte vi hele metoden i Eclipse IDE for å generere de automatiske Javadoc -kommentarene i løpet av noen få sekunder og med noen få klikk på GUI.