Javadoc készítés varázslóval állíthat elő Javadoc dokumentációt. Ez
a Java fejlesztőkészletben elérhető javadoc.exe eszköz felhasználói felülete. A
Javadoc eszköz teljes dokumentációját a Sun's Javadoc Tool oldalon találja.
A
Javadoc készítés varázslóval állíthat elő Javadoc dokumentációt. Ez
a Java fejlesztőkészletben elérhető javadoc.exe eszköz felhasználói felülete. A
Javadoc eszköz teljes dokumentációját a Sun's Javadoc Tool oldalon találja.
Típuskijelölés:
|
Option |
Description |
|---|---|
|
Javadoc parancs |
A javadoc előállításához használt parancs megadása. |
|
Jelölje ki azokat a típusokat, melyekhez Javadoc dokumentációt fog készíteni. |
Az exportálni kívánt típusok pontos meghatározása érdekében jelölje ki a listában lévő jelölőnégyzeteket vagy szüntesse meg kijelölésüket. A lista a munkaterület kijelölése szerint inicializálódik. |
|
Javadoc készítése tagok számára, láthatósággal |
|
|
Szabványos dokumentumkezelő kisalkalmazás használata |
Javadoc parancs indítása szabványos dokumentumkezelő kisalkalmazással (alapértelmezett)
|
|
Egyéni dokumentumkezelő kisalkalmazás használata |
Egyéni dokumentumkezelő kisalkalmazás használata dokumentáció készítéséhez
|
Szabványos dokumentumkezelő kisalkalmazás argumentumai ( Szabványos dokumentumkezelő kisalkalmazás használata kiválasztásakor elérhető):
|
Option |
Description |
|---|---|
|
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énti különálló tárgymutató | 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álasszon ki hivatkozott archívumokat és projekteket, amelyekhez hivatkozásokat kell előállítani |
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:
|
Option |
Description |
|---|---|
|
Á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. |
|
Virtuális gép beállítások |
Itt tetszőleges számú virtuális gép beállítás megadható. |
|
Extra Javadoc beállítások |
Itt tetszőleges számú extra beállítás megadható: Egyéni dokumentumkezelő
kisalkalmazás beállítások vagy JRE 1.4 kompatibilitási beállítások. |
|
JRE forráskompatibilitás |
A Javadoc eszköz által elfogadandó JRE forráskompatibilitás |
|
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.
