Generování dokumentace Javadoc

Otevře Průvodce dokumentace Javadoc Průvodce generováním dokumentace Javadoc umožňuje generovat dokumentaci Javadoc. Je to uživatelské rozhraní pro nástroj javadoc.exe, který je k dispozici v sadě Java JDK. Kompletní dokumentaci k nástroji Javadoc najdete na webové stránce na adrese Sun's Javadoc Tool.

První stránka

Výběr typu:

Volba

Popis

Vybrat typy, pro které bude dokumentace Javadoc generována

V seznamu zaškrtněte nebo naopak odstraňte zaškrtnutí z políček, a tím přesně určete, které typy se mají exportovat do souboru JAR. Tento seznam se inicializuje na základě výběru v pracovní ploše. Vybrat lze najednou vždy jen jeden projekt, protože při spuštění nástroje Javadoc je možno použít v daném okamžiku pouze jednu cestu ke třídě projektu.

Vytvořit dokumentaci Javadoc pro členy s viditelností

  • Soukromá: Dokumentace bude vytvořena pro všechny členy
  • Balíček: Dokumentace bude vytvořena pouze pro členy s výchozí, chráněnou nebo veřejnou viditelností
  • Chráněná: Dokumentace bude vytvořena pouze pro členy s chráněnou nebo veřejnou viditelností
  • Veřejná: Dokumentace bude vytvořena pouze pro členy s veřejnou viditelností (výchozí nastavení)


Použít standardní doclet

Spustit příkaz Javadoc se standardním docletem (výchozí nastavení) 

  • Místo určení: Vyberte místo určení, do něhož má standardní doclet zapsat vygenerovanou dokumentaci. Místo určení je argument specifický pro standardní doclet, a proto není při použití vlastního docletu tato volba zpřístupněna.


Použít vlastní doclet

Ke generování dokumentace použít vlastní doclet 

  • Název docletu: Stanovený název typu pro doclet
  • Cesta ke třídě docletu: Cesta ke třídě, kterou potřebuje třída docletu


Argumenty standardního docletu

Argumenty standardního docletu (dostupné po vybrání volby  Použít standardní doclet):

Volba

Popis

Název dokumentu

Zadejte název dokumentu.
Generovat stránku použití Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku použití.
Generovat strom hierarchie Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku stromu.

Generovat navigační panel

Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala navigační panel (záhlaví a zápatí).
Generovat index Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku Index.
Generovat index pro každé písmeno Vytvoří index pro každé písmeno. Tato volba je dostupná, když je vybraná volba Generovat index
@author Tuto volbu vyberte, pokud chcete, aby se vytvořila dokumentace pro značku @author.
@version Tuto volbu vyberte, pokud chcete, aby se vytvořila dokumentace pro značku @version.
@deprecated Tuto volbu vyberte, pokud chcete, aby se vytvořila dokumentace pro značku @deprecated.
deprecated list Tuto volbu vyberte, pokud chcete, aby dokumentace obsahovala stránku Deprecated page. Tato volba je dostupná, když je vybraná volba  @deprecated.
Vyberte odkazované třídy, ke kterým by měla dokumentace Javadoc vytvořit odkazy Zadejte, ke kterým dalším dokumentacím by měla dokumentace Javadoc vytvořit odkazy, když se odkazuje na jiné typy. 
  • Vybrat vše: Vytvořit odkazy ke všem umístěním jiných dokumentací
  • Vymazat vše: Nevytvářet odkazy k umístěním jiných dokumentací
  • Konfigurovat: Konfigurovat umístění dokumentace Javadoc odkazovaného souboru JAR nebo projektu.
Seznam stylů Vyberte seznam stylů, který se má použít

Obecné argumenty

Obecné volby dokumentace Javadoc:

Volba

Popis

Přehled

Určuje, že dokumentace Javadoc má získat text pro přehledovou dokumentaci z daného souboru. Tento text se umístí do souboru overview-summary.html.

Doplňující volby dokumentace Javadoc

Zde můžete přidat libovolný počet dalších voleb: volby pro vlastní doclet, volby pro systém VM nebo volby kompatibility s verzí JRE 1.4.
Uvědomte si, že argumenty obsahující mezery musí být uzavřeny do uvozovek. Pro argumenty, které specifikují kód html (např. -header) použijte   nebo ", abyste se vyhnuli mezerám a uvozovkám.

Uložit nastavení tohoto exportu dokumentace Javadoc jako skript Ant

Zadejte uložení skriptu Ant, který provede určený export dokumentace Javadoc bez nutnosti použití průvodce. Existující skript Ant lze tímto průvodcem upravit (Z kontextové nabídky u vygenerovaného skriptu Ant použijte příkaz Otevřít průvodce vytvořením dokumentace Javadoc)

Otevřít generovaný indexový soubor v prohlížeči Otevře vygenerovaný soubor index.html v prohlížeči (Tato volba je dostupná pouze při použití standardního docletu)

Klepnutím na  Dokončit spusťte generování dokumentace Javadoc. Pokud je místo určení odlišné od umístění určeného na stránce umístění dokumentace Javadoc projektu, objeví se dotaz, zda chcete umístění dokumentace Javadoc pro daný projekt nastavit na novou cílovou složku. V takovém případě všechna vyvolání příkazu Otevřít externí dokumentaci Javadoc budou používat nyní vytvořenou dokumentaci.

Bude spuštěn nový proces a vygenerování proběhne na pozadí. Otevřete pohled Konzola (Okno > Zobrazit pohled > Konzola), chcete-li zobrazit postup a stav generování.

Související úlohy

Vytváření dokumentace Javadoc

Související odkazy

Akce souboru
Vlastnosti umístění dokumentace Javadoc