Du kan bruge guiden
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.
Vælg type
Indstilling |
Beskrivelse |
---|---|
Vælg de typer, der skal oprettes Javadoc for |
Angiv nøjagtigt de typer, du vil eksportere til JAR-filen, ved at markere eller rydde de relevante felter i listen. Denne liste initialiseres af valget på arbejdsbænken. Du kan kun vælge et projekt ad gangen, fordi du kun kan et projekts classpath ad gangen, når du bruger Javadoc-værktøjet. |
Opret Javadoc for medlemmer med synlighed |
|
Brug standard-minidokument |
Start Javadoc-kommandoen med standard-doclet (standard)
|
Brug tilpasset minidokument |
Brug et tilpasset minidokument til at oprette dokumentation
|
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. |
Generér 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.
|
Typografiark | Vælg det typografiark, du vil bruge. |
Generelle Javadoc-parametre:
Indstilling |
Beskrivelse |
---|---|
Oversigt |
Angiver, at Javadoc skal hente teksten til oversigtsdokumentationen fra en fil. Den placeres i overview-summary.html. |
Ekstra Javadoc-parametre: |
Du kan tilføje et vilkårligt antal ekstra parametre her: Parametre for
tilpassede minidokumenter, virtuelle maskiner eller JRE
1.4-kompatibilitet. |
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.