Kuidas luua JavaDoc kommenteerides

JavaDoc on de facto standard tekitama dokumentatsiooni lähtekoodi.See on vahend, et luua HTML dokumente spetsiaalselt vormindatud kommentaare Java koodi.Seda saab kasutada, et luua struktureeritud rakenduse programmeerimise liidest (API) dokumendid automaatselt, anda mõned vihjed, et IDE või viitamisele pakendite, klasse ja meetodeid.Sisuliselt on see viis kommenteerides parameetrite kirjeldamiseks, kes kirjutas, mis ja kes on süüdi, kui see puruneb.Java kaasas javadoc käsurea programm, et luua HTML dokumentides, kuid kõige Java integreeritud keskkonnas (IDE-sid) on ka see integreeritud.

juhised

  1. Loo erilist javadoc kommentaarid.Tähistamaks javadoc kommentaar, alustada kommentaar koos / .JavaDoc kommentaarid tavaliselt olemas ülaosas faili, enne klassid ja enne meetodeid.Kuna see on mõeldud täis API dokumentatsioon, see ei ole ebatavaline, et näha faile rohkem javadoc kommentaare kui kood. "" /
    See on javadoc kommentaari.See ei ole javadoc meta-sildid, aga ta tegi val

    landada javadoc parser, kui heita pilk see kommentaar.
    / ""

  2. Lisa API meta-sildid (tags, mis kirjeldavad API ise) kommenteerides.API sildid on parameeter nimetused, kirjeldused, välja arvatud profiilid, tagastatav väärtus kirjelduse, meetod nimed ja meetodi kirjelduse.Paljud IDES lisada need andmed oma kohtspikriteks ja teised abilised, samuti seda et neid kasutatakse HTML või kommentaar vorm.

  3. Kasutage Meetodi kirjeldus.See meta-tag ei ​​ole tag name: See on lihtsalt kommentaar, et tuleb enne teisi sildid. "" / *
    Arvutab kalle rida.
    * / ""

  4. Lisada parameetrite kirjeldamiseks.Neid tähistatakse @ param meta-sildid, mis peaks järgnema parameetri nimi ja kirjeldus. "" / *
    Arvutab kalle rida.

    @ param p1 Esimene asi, mida kirjeldab line
    @ param p2 Teine asi, mis kirjeldab line
    / ""

  5. Tagastatav väärtus kirjelduse.See tähistataksereturn meta-tag ja peaks järgnema kirjeldus tagastatav väärtus. "" / *
    Arvutab kalle rida.

    @ param p1 Esimene asi, mida kirjeldab line
    @ param p2 Teine asi, mis kirjeldab line
    return joone tõus kui float
    * / ""

  6. Lisa omistamine sildid.Tags atribuut koodi konkreetse autori. "" / *
    Arvutab kalle rida.

    Author Jack Smith
    @ param p1 Esimene asi, mida kirjeldab line
    @ param p2 Teine asi, mis kirjeldab line
    return joone tõus kui float
    / ""

  7. Loo HTML dokumente.Kui te ei kasuta IDE või sa lihtsalt tahad seda teha käsitsi, saate käivitada javadoc käsurea programmi projekti kataloogi.Määra väljundi kataloog koos -d lüliti ja andke seda nimekirja java failid (tavaliselt, kui otsid). "" Javadoc -d docs * java ""

Tips & amp;Hoiatused

  • Kui te kasutate IDE, HTML dokumente ilmselt teha automaatselt osana ehitamisel.Vaadake oma IDE dokumentatsiooni selle kinnitamiseks.
  • Multi-line kommentaare Java traditsiooniliselt alustada /
  • , kuid ekstra tärniga märk JavaDoc märku javadoc parser hakata otsima javadoc meta-sildid.
168
0
1
Java Programming