Med veiviseren
Javadoc-generering kan du generere Javadoc. Det er et brukergrensesnitt
for javadoc.exe-verktøyet som er tilgjengelig i Java JDK. Les Sun's Javadoc Tool, der du
finner komplett dokumentasjon av Javadoc-verktøyet.
Typevalg:
Alternativ |
Beskrivelse |
---|---|
Velg typer for Javadoc-generering |
På listen merker du av eller fjerner merket i boksene for å oppgi nøyaktig de typene du vil eksportere til JAR-filen. Denne listen blir initialisert av arbeidsbenkutvalget. Du kan bare velge ett prosjekt om gangen, fordi bare ett prosjekts klassebane kan brukes om gangen ved kjøring av Javadoc-verktøyet. |
Opprett Javadoc for medlemmer med synlighet |
|
Bruk standard Doclet |
Start Javadoc-kommandoen med standard doclet (standardverdi)
|
Bruk tilpasset Doclet |
Bruk en tilpasset doclet til å generere dokumentasjonen
|
Standard doclet-argumenter (tilgjengelig når Bruk standard doclet er valgt):
Alternativ |
Beskrivelse |
---|---|
Dokumenttittel |
Oppgi dokumenttittel. |
Generer bruksside | Velg dette alternativet hvis du vil at dokumentasjonen skal inneholde en bruksside. |
Generer hierarkitre | Velg dette alternativet hvis du vil at dokumentasjonen skal inneholde en treside. |
Generer navigeringslinje |
Velg dette alternativet hvis du vil at dokumentasjonen skal inneholde en navigeringslinje (topptekst og bunntekst) |
Generer indeks | Velg dette alternativet hvis du vil at dokumentasjonen skal inneholde en indeksside. |
Generer indeks per bokstav | Opprett en indeks per bokstav. Aktivert når Generer indeks er valgt. |
@author | Velg dette alternativet hvis du vil at @author-koden skal dokumenteres. |
@version | Velg dette alternativet hvis du vil at @version-koden skal dokumenteres. |
@deprecated | Velg dette alternativet hvis du vil at @deprecated-koden skal dokumenteres. |
Foreldet liste | Velg dette alternativet hvis du vil at dokumentasjonen skal inneholde en Foreldet-side. Aktivert når @deprecated-alternativet er valgt. |
Velg refererte klasse som Javadoc skal opprette linker til |
Oppgi til hvilken annen dokumentasjon Javadoc skal opprette linker når det refereres til andre typer.
|
Stilark | Velg stilarket som skal brukes |
Generelle Javadoc-alternativer:
Alternativ |
Beskrivelse |
---|---|
Oversikt |
Spesifiserer at Javadoc skal hente teksten for oversiktsdokumentasjonen fra gitt fil. Den vil bli plassert i overview-summary.html. |
Ekstra Javadoc-alternativer |
Legg til et antall
ekstra alternativer her: Tilpassede doclet-alternativer, VM-alternativer eller
alternativer for JRE 1.4-kompatibilitet. |
Lagre innstillingene for denne Javadoc-eksporten som et Ant-skript: |
Oppgi lagring av et Ant-skript som skal utføre spesifisert Javadoc-eksport uten behov for å bruke veiviser. Eksisterende Ant-skript kan endres med denne veiviseren (bruk veiviseren "Åpne Javadoc" fra hurtigmenyen på det genererte Ant-skriptet). |
Åpne generert indeksfil i nettleser | Åpner den genererte index.html-filen i nettleseren (tilgjengelig bare ved bruk av standard doclet). |
Klikk på Fullfør for å starte Javadoc-genereringen. Hvis målet er forskjellig fra plasseringen som er konfigurert på siden Javadoc-plassering for prosjektet, blir du spurt om du vil definere prosjektets Javadoc-plassering til den nye målmappen. Gjør du det, vil alle aktiveringer av Åpne eksternt Javadoc bruke den opprettede dokumentasjonen.
En ny prosess vil startes, og den nye genereringen utføres i bakgrunnen. Åpne Konsoll-visningen (Vindu > Vis visning > Konsoll) for å se på fremdrift og status for genereringen.
Opprette Javadoc-dokumentasjon