Ezzel a varázslóval Javadoc dokumentációt készíthet. A Java fejlesztőkészletben elérhető javadoc.exe eszköz felhasználói felülete. Látogassa meg a Sun's Javadoc Tool oldalt a Javadoc eszköz teljes dokumentációjának megtekintéséhez.
Típuskijelölés:
|
Beállítás |
Leírás |
|---|---|
|
Jelölje ki azokat a típusokat, melyekhez Javadoc dokumentációt fog készíteni. |
A listában válassza ki vagy hagyja üresen a kereteket aszerint, hogy mely típusokat kívánja exportálni a JAR fájlba. A lista a munkaterület kijelölése szerint inicializálódik. Egyszerre csak egy projektet lehet kijelölni, mivel a Javadoc eszköz futtatásával egy időben csak egy projekt osztályútvonalát lehet használni. |
|
Javadoc készítése tagok számára, láthatósággal |
|
|
Szabvány dokumentummegjelenítő kisalkalmazás használata |
Javadoc parancs indítása szabvány dokumentummegjelenítő kisalkalmazással (alapértelmezett)
|
|
Egyéni dokumentummegjelenítő kisalkalmazás használata |
Egyéni dokumentummegjelenítő kisalkalmazás használata dokumentáció készítéséhez
|
Szabvány dokumentummegjelenítő kisalkalmazás paraméterei ( Szabvány dokumentummegjelenítő kisalkalmazás használata kiválasztásakor elérhető):
|
Beállítás |
Leírás |
|---|---|
|
Dokumentum címe |
Adjon meg egy dokumentumcímet. |
| Használat oldal készítése | Akkor válassza ezt a lehetőséget, ha az szeretné, hogy a dokumentáció tartalmazzon egy Használat oldalt. |
| Hierarchiafa készítése | Akkor válassza ezt a lehetőséget, ha az szeretné, hogy a dokumentáció tartalmazzon egy Fa oldalt. |
|
Navigációsor készítése |
Akkor válassza ezt a lehetőséget, ha az szeretné, hogy a dokumentáció tartalmazzon egy navigációsort (fejléc és lábléc). |
| Tárgymutató készítése | Akkor válassza ezt a lehetőséget, ha az szeretné, hogy a dokumentáció tartalmazzon egy tárgymutató oldalt. |
| Betűnként egy tárgymutató készítése | Betűnként egy tárgymutatót készít. Elérhető, ha a Tárgymutató készítése ki van választva. |
| @author | Akkor válassza ezt a lehetőséget, ha az szeretné, hogy az @author címke dokumentálva legyen. |
| @version | Akkor válassza ezt a lehetőséget, ha az szeretné, hogy a @version címke dokumentálva legyen. |
| @deprecated | Akkor válassza ezt a lehetőséget, ha az szeretné, hogy a @deprecated címke dokumentálva legyen. |
| elavult lista | Akkor válassza ezt a lehetőséget, ha az szeretné, hogy a dokumentáció tartalmazzon egy Elavult oldalt. Elérhető, ha a @deprecated lehetőség ki van választva. |
| Válassza ki a hivatkozott osztályokat, melyekhez a Javadoc készítsen linkeket |
Adja meg, hogy a Javadoc milyen más dokumentációkhoz készítsen
hivatkozásokat,
ha más típusokra történt hivatkozás.
|
| Stíluslap | Válassza ki a használni kívánt stíluslapot |
Általános Javadoc beállítások:
|
Beállítás |
Leírás |
|---|---|
|
Áttekintés |
Meghatározza, hogy a Javadoc lekérdezze-e az adott fájlból a szöveget az áttekintő dokumentációhoz. Ez az overview-summary.html fájlba fog kerülni. |
|
Extra Javadoc beállítások |
Itt bármennyi extra beállítást felvehet: a dokumentummegjelenítő
kisalkalmazás egyéni beállításait, JRE 1.4 kompatibilitási beállításokat. |
|
Javadoc export beállításainak mentése Ant parancsfájlként |
Ha Ant parancsfájlként tárolja el ezeket a beállításokat, akkor a megadott Javadoc exportot a parancsfájl végre tudja hajtani, a varázsló használata nélkül. Ezzel a varázslóval módosítani lehet létező Ant parancsfájlokat (használja a létrehozott Ant parancsfájl előugró menüjének 'Javadoc varázsló megnyitása' menüpontját). |
| Előállított indexfájl megnyitása böngészőben | Az elkészített index.html fájlt a böngészőben nyitja meg (csak a szabvány dokumentummegjelenítő kisalkalmazás használatakor elérhető) |
Kattintson a Befejezés gombra a Javadoc elkészítéséhez. Ha a cél különbözik a projekt Javadoc helye oldal alatt megadottaktól, akkor meg kell erősítenie, hogy a projekt Javadoc dokumentációjának helyét az új célmappára akarja állítani. Miután ezt megtette, a Külső Javadoc megnyitása utasítás a most létrehozott dokumentációt fogja használni.
Elindul egy új folyamat, és az előállítás a háttérben lesz elvégezve. Nyissa meg a Konzol nézetet (Ablak > Nézet megjelenítése > Konzol) az előállítás állapotának megtekintéséhez.

Javadoc dokumentáció készítése