Generera Javadoc

Med guiden Öppnar du guiden Javadoc Generera Javadoc genererar du Javadoc. Det är ett användargränssnitt för verktyget javadoc.exe som finns i Java JDK. På sidan för Suns Javadoc-verktyg hittar du en fullständig dokumentation av Javadoc-verktyget.

Första sidan

Välj typ:

Alternativ

Beskrivning

Välj typer som Javadoc ska genereras för

Markera och avmarkera kryssrutorna i listan när du vill ange vilka typer som ska exporteras till JAR-filen. Listan initieras av valen i arbetsmiljön. Endast ett projekt åt gången kan markeras eftersom classpath (klassökväg) för endast ett projekt åt gången kan användas när du kör Javadoc-verktyget.

Skapa Javadoc för medlemmar med följande synlighet

  • Privat: Alla medlemmar dokumenteras
  • Paket: Endast medlemmar med standardsynlighet, skyddad eller publik synlighet dokumenteras
  • Skyddad: Endast medlemmar med skyddad eller publik synlighet dokumenteras
  • Publik: Endast medlemmar med publik synlighet dokumenteras (standard)


Använd standard-Doclet

Startar Javadoc-kommandot med standard-Doclet. (standard) 

  • Mål: välj ett mål där den genererade dokumentationen ska skrivas. Målet är ett Doclet-specifikt argument och är därför inte aktiverat när du använder en anpassad Doclet.


Använd anpassad Doclet

Använd en anpassad Doclet till att generera dokumentationen. 

  • Doclet-namn: Fullständigt typnamn på Doclet
  • Doclet-klassökväg: Klassökväg som krävs för Doclet-klassen


Argument för standard-Doclet

Argument för standard-Doclet (tillgängligt när Använd standard-Doclet har valts):

Alternativ

Beskrivning

Dokumenttitel

Ange en dokumenttitel.
Generera användningssida Välj det här alternativet om du vill att dokumentationen ska innehålla en användningssida.
Generera hierarkiträd Välj det här alternativet om du vill att dokumentationen ska innehålla en trädsida.

Generera navigeringslist

Välj det här alternativet om du vill att dokumentationen ska innehålla en navigeringslist (sidhuvud och sidfot).
Generera index Välj det här alternativet om du vill att dokumentationen ska innehålla en indexsida.
Generera index efter bokstav Skapar ett index efter bokstav. Aktiverat om Generera index är valt. 
@author Välj det här alternativet om du vill att märkordet @author ska dokumenteras.
@version Välj det här alternativet om du vill att märkordet @version ska dokumenteras.
@deprecated Välj det här alternativet om du vill att märkordet @deprecated ska dokumenteras.
utkommenterad lista Välj det här alternativet om du vill att dokumentationen ska innehålla en sida med en utkommenterad lista. Aktiverad när alternativet @deprecated är valt.
Välj refererade klasser som Javadoc skapar länkar till Ange vilken annan dokumentation Javadoc ska skapa länkar till när andra typer refereras. 
  • Markera alla - Skapa länkar till alla andra dokumentationsplatser.
  • Avmarkera alla - Skapa inga länkar till andra dokumentationsplatser.
  • Konfigurera - Konfigurera Javadoc-platsen för en refererad JAR-fil eller ett projekt.
Formatmall Välj den formatmall som ska användas.

Allmänna argument

Allmänna Javadoc-alternativ:

Alternativ

Beskrivning

Översikt

Anger att Javadoc ska hämta översiktsdokumentationens text från den angivna filen. Den placeras i overview-summary.html.

Extra Javadoc-alternativ

Lägg till valfritt antal extra alternativ här: alternativ för anpassad Doclet, VM-alternativ eller JRE 1.4-kompatibilitetsalternativ.
Observera att argument som innehåller blanktecken måste omslutas av citattecken. För argument som anger HTML-kod (t.ex. -header) använder du   eller " för att undvika blanktecken och citattecken.

Spara inställningarna för den här Javadoc-exporten som ett Ant-skript

Välj det här alternativet om du vill spara ett Ant-skript som utför den angivna Javadoc-exporten utan att guiden används. Befintliga Ant-skript kan du ändra på med guiden. (Använd guiden Öppna Javadoc på kontextmenyn för det genererade Ant-skriptet.)

Öppna genererad indexfil i webbläsare Öppnar den genererade index.html-filen i webbläsaren. (Endast tillgängligt om du använder standard-Doclet.)

Klicka på Slutför så startas Javadoc-genereringen. Om målet är en annan plats än den som konfigurerades för projektets Javadoc-platssida uppmanas du att ange om du vill ange projektets Javadoc-plats till den nya målmappen. Om du gör det kommer alla aktiveringar av Öppna extern Javadoc att använda den nyskapade dokumentationen.

En ny process startas och genereringen utförs i bakgrunden. Öppna konsolvyn (Fönster > Visa vy > Konsol) så visas förloppet och status på genereringen.

Närliggande uppgifter

Skapa Javadoc-dokumentation

Närliggande referens

Filåtgärder
Egenskaper för Javadoc-platsen