Hvor legger jeg Javadoc-kommentarer?

2024 Forfatter: Lynn Donovan | [email protected]. Sist endret: 2023-12-15 23:51

De javadoc verktøyet lar deg sette din kommentarer rett ved siden av koden din, inne i ". java " kildefiler. Når du er fornøyd med koden og kommentarer , kjører du ganske enkelt javadoc kommandoen og HTML-stilen din dokumentasjon opprettes automatisk for deg.

Så, hvordan legger du til kommentarer til en Javadoc?

Husk følgende når du bruker Legg til Javadoc-kommentar (Alt+Shift+J): Til legge til en kommentar til et felt, plasser markøren på feltdeklarasjonen. Til legge til en kommentar til en metode, plasser markøren hvor som helst i metoden eller på dens erklæring.

hva er bruken av Javadoc-kommentarer? Javadoc er et verktøy som følger med JDK, og det er det brukt for å generere Java kodedokumentasjon i HTML-format fra Java kildekode, som krever dokumentasjon i et forhåndsdefinert format. Følgende er et enkelt eksempel hvor linjene i /*…. */ er Java flere linjer kommentarer.

Derav, hvor legger jeg Javadoc?

Du kan plassere JavaDoc-kommentarer på en av tre forskjellige steder i en kildefil:

1. Umiddelbart før erklæringen av en offentlig klasse.
2. Umiddelbart før erklæringen av et offentlig felt.
3. Umiddelbart før erklæringen av en offentlig metode eller konstruktør.

Hvordan skriver jeg Javadoc-kommentarer i Intellij?

3 svar. Ved å skrive /** + og deretter trykke Enter over vil en metodesignatur opprette Javadoc stubber for deg. Du kan bruk handlingen 'Fix doc kommentar '. Den har ikke en standard snarvei, men du kan tilordne Alt + Shift + J snarveien til den i tastaturet, fordi denne snarveien ikke brukes til noe annet.