Miten luodaan Javadoc Kun kommentoi

Javadoc on de facto -standardi tuottaa dokumentaatiota lähdekoodista.Se on työkalu luoda HTML-asiakirjoja erityisesti muotoiltuja kommentteja Java-koodia.Tätä voidaan käyttää tuottamaan rakenteellisen Application Programming Interface (API) dokumentaatio automaattisesti, antaa joitakin vinkkejä IDE tai jakamiseen paketteja, luokat ja menetelmät.Pohjimmiltaan se on tapa kommentoida parametrikuvaukset, joka kirjoitti mitä ja kuka syyttää, jos se rikkoutuu.Java mukana javadoc komentorivin ohjelma tuottaa HTML dokumentointi, mutta useimmat Java integroitu kehitysympäristöt (IDES) myös tämä integroitu.

Ohjeet

  1. Luo erityistä Javadoc kommentteja.Tarkoittamaan javadoc kommentin, aloita kommentti / .Javadoc kommentit yleensä esiintyy yläreunassa tiedoston, ennen luokkia ja ennen menetelmiä.Koska se on suunniteltu täysin API-dokumentaation, se ei ole harvinaista nähdä tiedostoja enemmän javadoc kommentteja kuin koodin. "" /
    Tämä on Javadoc kommentti.Se ei ole javadoc metakoodien v

    ielä, mutta se ei laukaista javadoc jäsennin katsomaan tämä kommentti.
    / ""

  2. Lisää API meta-tageja (tunnisteita, jotka kuvaavat API itse) ottaessaan kantaa.API tunnisteet ovat parametrien nimet, kuvaukset, lukuun ottamatta profiilit, paluu arvo kuvaukset, menetelmä nimiä ja menetelmä kuvaukset.Monet IDE sisällyttää tämän tiedon niiden työkaluvihjeet ja muita auttajia, samoin kuin se on tarkoitettu käytettäväksi HTML tai kommentin muodossa.

  3. käyttö menetelmän kuvaus.Tämä meta-tagia ei ole tunnistetta nimi: Se on yksinkertaisesti kommentti, joka tulee ennen muita tunnisteita. "" / *
    Laskee viivan kaltevuus.
    * / ""

  4. Sisällytä parametrien kuvaukset.Nämä on merkittyparam meta-tageja, jotka tulisi seurata parametrin nimi ja kuvaus. "" / *
    Laskee viivan kaltevuus.

    param P1 ensimmäisen kohdan, joka kuvaa linja
    param p2 Toinen seikka, joka kuvaa linja
    / ""

  5. Paluuarvo kuvauksia.Tämä on merkittyreturn meta-tunnisteen ja jälkeen olisi kuvaus palauttaa arvon. "" / *
    Laskee viivan kaltevuus.

    param P1 ensimmäisen kohdan, joka kuvaa linja
    param p2 Toinen kohta, joka kuvaa linja
    return kaltevuus linjan float
    * / ""

  6. Lisää nimeäminen tunnisteita.Tunnisteet ominaisuus koodin tiettyä tekijää. "" / *
    Laskee viivan kaltevuus.

    author Jack Smith
    param P1 ensimmäisen kohdan, joka kuvaa linja
    param p2 Toinen kohta, joka kuvaa linja
    return kaltevuus linjan float
    / ""

  7. Luo HTML asiakirjat.Jos et käytä IDE tai haluat vain tehdä sen manuaalisesti, voit suorittaa javadoc komentorivin ohjelma projektin hakemistoon.Määritä tulostehakemisto kanssa -d kytkin ja siirtää se lista .java tiedostot (yleensä jokerimerkkinä). "" Javadoc -d Docs * .java ""

Vinkkejä & amp;Varoitukset

  • Kun käytät IDE, HTML asiakirjat on todennäköisesti tapahtuu automaattisesti osana rakentaa prosessi.Katso IDE asiakirjat vahvistavan tämän.
  • Usean rivin kommentit Java perinteisesti aloittaa /
  • , mutta ylimääräinen tähti merkki Javadoc signaloi javadoc jäsennin lähteä etsimään javadoc meta-tageja.
419
0
1
Java Ohjelmointi