Javadoc er de facto standard for generering av dokumentasjon fra kildekoden. Det er et verktøy for å lage HTML-dokumentasjon fra spesielt formaterte kommentarer i Java-kode . Dette kan brukes til å generere strukturert programmeringsgrensesnitt ( API ) dokumentasjon automatisk , gi noen hint til IDE eller for tildeling av pakker , klasser og metoder. I hovedsak er det en måte å kommentere parameter beskrivelser , skrev hvem hva, og hvem som har skylden hvis det bryter . Java kommer med javadoc kommandolinje- program for å generere HTML- dokumentasjon, men de fleste Java integrerte utviklingsmiljøer ( IDE ) har også dette integrert. Instruksjoner
en

Lage spesielle javadoc kommentarer . For å betegne en javadoc kommentar , starte kommentaren med /** . Javadoc kommentarer vanligvis finnes på toppen av en fil , før klasser og før metoder. Siden den er designet for fullt API dokumentasjon , er det ikke uvanlig å se filer med flere javadoc kommentarer enn kode . "" /*** Dette er en javadoc kommentar. Det har ikke noen javadoc meta -tags ennå, men det gjorde utløse javadoc parser til å ta en titt på denne kommentaren . * /" "
2

Legg API meta- tags ( koder som beskriver API seg selv ) når kommentere . API kodene er parameternavn , beskrivelser , unntak profiler, returverdi beskrivelser , metode navn og metode beskrivelser. Mange IDE innlemme disse dataene inn i sine verktøytips og andre hjelpere , samt at det er for bruk i HTML eller kommentar skjema .
3

Bruk metoden beskrivelse. Denne meta- tag har ingen tag name: Det er rett og slett den kommentaren som kommer før de andre kodene "" /*** Beregner skråningen av en linje. . * /" "
4

innlemme parameter beskrivelser . Disse er merket med @ param meta -tags , som bør følges av en parameter navn og beskrivelse. "" /*** Beregner skråningen av en linje. ** @ Param p1 Første punkt som beskriver linjen * @ param p2 Andre punkt som beskriver linjen * /""
5

returverdi beskrivelser . Dette er merket med @ return meta - tag og bør følges av en beskrivelse av avkastningen verdi. "" /*** Beregner skråningen av en linje. ** @ Param p1 Første punkt som beskriver linjen * @ param p2 Andre punkt som beskriver linjen * @ return Slope av linjen som en dupp * /" "
6

Legg navngivelse koder. Kodene tilskriver koden til en bestemt forfatter . "" /*** Beregner skråningen av en linje. ** @ Forfatter Jack Smith * @ param p1 Første punkt som beskriver linjen * @ param p2 Andre punkt som beskriver linjen * @ return Slope av linjen som en dupp * /" "
7

generere HTML- dokumentasjon. Hvis du ikke bruker en IDE eller du bare ønsker å gjøre det manuelt , kan du kjøre javadoc kommandolinje- program fra prosjektet katalogen. Spesifisere output katalog med -d -bryteren og gi det en liste over . Java -filer ( vanligvis som et wildcard ) . " " Javadoc -d docs * . Java " "