Voit luoda Javadoc-dokumentaation ohjatun
Javadoc-luontitoiminnon avulla. Se on käyttöliittymä javadoc.exe-työkalua varten, joka on saatavilla Java JDK:sta. Javadoc-työkalun koko dokumentaatio on Sunin Javadoc-työkalun sivulla.
Tyypin valinta:
Asetus |
Kuvaus |
---|---|
Valitse tyypit, joille Javadoc luodaan |
Määritä tarkasti tyypit, jotka haluat viedä JAR-tiedostoon, valitsemalla ruutuja tai poistamalla ruutujen valintoja. Työympäristön valinta alustaa tämän luettelon. Vain yksi projekti voidaan valita heti, sillä vain yhtä projektin luokkapolkua voidaan käyttää ajettaessa Javadoc-työkalua. |
Luo Javadoc jäsenille näkyvyyden mukaan |
|
Käytä vakiodocletia |
Käynnistä Javadoc-komento käyttämällä vakiodocletia (oletusarvo)
|
Käytä mukautettua docletia |
Muodosta dokumentaatio käyttämällä mukautettua docletia
|
Vakiodocletin argumentit (käytettävissä, jos Käytä vakiodocletia on valittuna):
Asetus |
Kuvaus |
---|---|
Asiakirjan otsikko |
Määritä asiakirjan otsikko. |
Muodosta käyttösivu | Valitse tämä vaihtoehto, jos haluat dokumentaation sisältävän käyttösivun. |
Muodosta hierarkiarakenne | Valitse tämä vaihtoehto, jos haluat dokumentaation sisältävän rakennesivun. |
Muodosta siirtymispalkki |
Valitse tämä vaihtoehto, jos haluat dokumentaation sisältävän siirtymispalkin (ylä- ja alatunniste). |
Muodosta hakemisto | Valitse tämä vaihtoehto, jos haluat dokumentaation sisältävän hakemistosivun. |
Erota hakemisto kirjaimen mukaan | Erota hakemisto kirjaimen mukaan. Käytössä, jos Muodosta hakemisto on valittuna. |
@author | Valitse tämä vaihtoehto, jos haluat @author-tunnisteen dokumentoiduksi. |
@version | Valitse tämä vaihtoehto, jos haluat @version-tunnisteen dokumentoiduksi. |
@deprecated | Valitse tämä vaihtoehto, jos haluat @deprecated-tunnisteen dokumentoiduksi. |
vanhentuneet-luettelo | Valitse tämä vaihtoehto, jos haluat dokumentaation sisältävän Vanhentuneet-sivun. Käytössä, jos @deprecated-vaihtoehto on valittuna. |
Valitse viitatut luokat, joihin Javadocin pitäisi luoda linkkejä |
Määritä, mihin muuhun dokumentaation Javadocin pitäisi luoda linkkejä, kun muihin tyyppeihin viitataan.
|
Tyylitiedosto | Valitse käytettävä tyylitiedosto. |
Yleiset Javadoc-asetukset:
Asetus |
Kuvaus |
---|---|
Yleiskuvaus |
Määrittää, että Javadocin pitäisi noutaa yleiskuvausdokumentaation teksti annetusta tiedostosta. Se sijoitetaan tiedostoon overview-summary.html. |
Javadoc-lisäasetukset |
Voit lisätä haluamasi määrän lisäasetuksia: mukautetun docletin asetukset, näennäiskoneen asetukset tai JRE 1.4 -yhteensopivuuden asetukset. |
Tallenna tämän Javadoc-viennin asetukset Ant-komentosarjana |
Määritä, jos haluat tallentaa Ant-komentosarjan, joka suorittaa määritetyn Javadoc-viennin ilman ohjattua toimintoa. Tällä ohjatulla toiminnolla voidaan muuttaa olemassa olevaa Ant-komentosarjaa (valitse luodun Ant-komentosarjan pikavalikosta Avaa ohjattu Javadoc-toiminto). |
Avaa muodostettu hakemistotiedosto selaimessa | Avaa muodostetun index.html-tiedoston selaimessa (käytettävissä vain käytettäessä vakiodocletia). |
Aloita Javadoc-muodostus napsauttamalla Valmis-painiketta. Jos kohde ei ole sama kuin projektin Javadoc-sijainti-sivulla määritetty sijainti, järjestelmä kysyy, haluatko määrittää projektin Javadoc-sijainnin uudeksi kohdekansioksi. Kun teet näin, kaikki Avaa ulkoinen Javadoc -kutsut käyttävät nyt luotua dokumentaatiota.
Uusi prosessi alkaa ja muodostus suoritetaan taustalla. Avaamalla konsolinäkymän (Ikkuna > Näytä näkymä > Konsoli) näet muodostuksen tilannetiedot ja tilan.