Javadoc-generering

Du kan bruge guiden Åbner guiden Javadoc Javadoc-generering til at genere Javadoc. Det er en brugergrænseflade til javadoc.exe-værktøjet, der findes i Java JDK. Hele dokumentationen til Javadoc-værktøjet findes på Suns Javadoc Tool-side.

Første side

Vælg type

Indstilling

Beskrivelse

Javadoc-kommando

Angiv den kommando, der skal bruges til generering Javadoc.

Vælg de typer, der skal oprettes Javadoc for

Markér eller fjern markeringen i afkrydsningsfelterne for præcist at angive de typer, du vil eksportere. Denne liste initialiseres af valget på arbejdsbænken.

Opret Javadoc for medlemmer med synlighed

  • Privat: Alle medlemmer bliver dokumenteret
  • Pakke: Kun medlemmer med standardsynlighed, beskyttet synlighed eller offentlig synlighed bliver dokumentereret
  • Beskyttet: Kun medlemmer med beskyttet synlighed eller offentlig synlighed bliver dokumentereret
  • Offentlig: Kun medlemmer med offentlig synlighed bliver dokumentereret (standard)

Brug standard-minidokument

Start Javadoc-kommandoen med standard-doclet (standard) 

  • Destination: Vælg den destination, som standardminidokumentet skriver den oprettede dokumentation til. Destinationen er et minidokumentspecifikt argument og aktiveres derfor ikke ved brug af et tilpasset minidokument.


Brug tilpasset minidokument

Brug et tilpasset minidokument til at oprette dokumentation 

  • Navn på minidokument: Fuldstændigt typenavn på minidokumentet
  • Classpath for minidokument: Classpath som minidokumentklassen skal bruge

Argumenter til standardminidokumenter

Argumenter til standardminidokumenter (kan anvendes, hvis du har valgt Brug standard-minidokument):

Indstilling

Beskrivelse

Dokumenttitel

 Angiv en dokumenttitel
Generér brug side Vælg denne mulighed, hvis dokumentationen skal indeholde en brug side.
Generér hierarkisk træstruktur Vælg denne mulighed, hvis dokumentationen skal indeholde en side med træstruktur.

Generér navigatorlinje

 Vælg denne mulighed, hvis dokumentationen skal indeholde en navigatorlinje (toptekst og bundtekst).
Generér indekser Vælg denne mulighed, hvis dokumentationen skal indeholde en indeksside.
Adskil indeks pr. bogstav Opret et indeks pr. bogstav. Aktiveret, hvis du har valgt Generér indeks. 
@author Vælg denne mulighed, hvis @author-koden skal dokumenteres.
@version Vælg denne mulighed, hvis @version-koden skal dokumenteres.
@deprecated Vælg denne mulighed, hvis @deprecated-koden skal dokumenteres.
forældet liste Vælg denne mulighed, hvis dokumentationen skal indeholde en forældet-side. Aktiveret, hvis du har valgt @deprecated.
Vælg de refererede klasser, som Javadoc skal oprette link til Angiv hvilken anden dokumentation, Javadoc skal oprette link til, hvis der refereres til andre typer.  
  • Markér alle: Opret link til alle andre dokumentplaceringer.
  • Ryd alle: Opret ingen link til andre dokumentplaceringer.
  • Konfigurér: Konfigurér Javadoc-placeringen for en JAR eller et projekt, der refereres til.
Typografiark Vælg det typografiark, du vil bruge.

Generelle argumenter

Generelle Javadoc-parametre:

Indstilling

Beskrivelse

Oversigt

Angiver, at Javadoc skal hente teksten til oversigtsdokumentationen fra en fil. Den placeres i overview-summary.html.

VM-indstillinger

Tilføj her så mange ekstra VM-indstillinger, du vil.

Ekstra Javadoc-indstillinger:

Du kan tilføje et vilkårligt antal ekstra indstillinger her: Indstillinger for tilpassede minidokumenter eller JRE 1.4-kompatibilitet.
Argumenter, der indeholder mellemrum, skal sættes i anførselstegn. Argumenter, der angiver html-kode (f.eks. -header), bruger &  eller &" for at undgå mellemrum og anførselstegn.

JRE-kildekompatibilitet

Den JRE-kildekompatibilitet, der skal accepteres af javadoc-værktøjet.

Gem indstillingerne for denne Javadoc-eksport som Ant-script

Angiv, at du vil gemme et Ant-script, som skal udføre den angivne Javadoc-eksport uden at bruge en guide. Et eksisterende Ant-script kan revideres ved hjælp af denne guide (Brug guiden Åbn Javadoc på kontekstmenuen til det genererede Ant-script).
Åbn genereret indeksfil i browser Åbner den genererede index.html-fil i en browser (kan kun bruges, hvis du anvender standard-minidokumentet).

Vælg Afslut for at starte Javadoc-genereringen. Hvis destinationen er en anden end den, der er angivet på projektets side til Javadoc-placering, bliver du spurgt, om projektets Javadoc-placering skal være i den nye destinationsfolder. Så vil den nu åbnede dokumentation blive anvendt ved alle starter af Åbn ekstern Javadoc.

En ny proces startes, og genereringen udføres i baggrunden. Åbn konsoloversigten (Vindue > Vis oversigt > Konsol) for at få vist status for genereringen.

Relaterede opgaver

Opret Javadoc-dokumentation

Relaterede referencer

Filfunktioner
Egenskaber for Javadoc-placering