Indholdsfortegnelse:

Hvor sætter jeg Javadoc-kommentarer?
Hvor sætter jeg Javadoc-kommentarer?

Video: Hvor sætter jeg Javadoc-kommentarer?

Video: Hvor sætter jeg Javadoc-kommentarer?
Video: Generating our own JavaDocs for our Package 2024, November
Anonim

Det javadoc værktøj lader dig sætte din kommentarer lige ved siden af din kode, inde i din ". java " kildefiler. Når du er tilfreds med din kode og kommentarer , kører du blot javadoc kommando og din HTML-stil dokumentation oprettes automatisk til dig.

Hvordan tilføjer du så kommentarer til en Javadoc?

Husk følgende ved brug Tilføj Javadoc-kommentar (Alt+Shift+J): Til tilføje -en kommentar til et felt skal du placere markøren på felterklæringen. Til tilføje -en kommentar til en metode skal du placere markøren hvor som helst i metoden eller på dens erklæring.

hvad er brugen af Javadoc-kommentarer? Javadoc er et værktøj, der følger med JDK, og det er det Brugt til at generere Java kode dokumentation i HTML-format fra Java kildekode, som kræver dokumentation i et foruddefineret format. Følgende er et simpelt eksempel, hvor linjerne inde i /*…. */ er Java multi-line kommentarer.

Heraf, hvor skal jeg placere Javadoc?

Du kan placere JavaDoc-kommentarer på en af tre forskellige steder i en kildefil:

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

Hvordan skriver jeg Javadoc-kommentarer i Intellij?

3 svar. Ved at skrive /** + og derefter trykke på Enter over vil en metodesignatur skabe Javadoc stubber til dig. Du kan brug handlingen 'Ret dok kommentar '. Den har ikke en standardgenvej, men du kan tildele Alt + Shift + J-genvejen til den i tastaturet, fordi denne genvej ikke bruges til andet.

Anbefalede: