Javadoc är de facto-standard för generering av dokumentation från källkod . Det är ett verktyg för att skapa HTML- dokumentation från speciellt formaterade kommentarer i Java-kod . Detta kan användas för att generera strukturerad application programming interface ( API ) dokumentation automatiskt , ger några tips till IDE eller för tilldelning av paket , klasser och metoder . I huvudsak är det ett sätt att kommentera parameterbeskrivningar , skrev vem vad , och vem som bär skulden om det går sönder . Java kommer med javadoc kommandoraden program för att generera HTML- dokumentation , men de flesta Java integrerade utvecklingsmiljöer ( IDE ) har också denna integrerade . Instruktioner
1
Skapa speciella javadoc kommentarer . Att beteckna en javadoc kommentar , börja kommentaren med /** . Javadoc kommentarer existerar vanligtvis på toppen av en fil , innan klasser och före metoder. Eftersom den är utformad för full API-dokumentation , är det inte ovanligt att se filer med mera Javadoc kommentarer än koden . " " /*** Detta är en javadoc kommentar . Det har inte någon javadoc meta-taggar ännu , men det gjorde utlösa javadoc tolken att ta en titt på den här kommentaren . * /" "
2
Lägg API meta- taggar ( taggar som beskriver API själv) när kommentera . API taggar är parameternamn , beskrivningar , profiler undantag , avkastning beskrivningar värde , namn metod och metodbeskrivningar . Många IDE införliva dessa data i sina verktygstips och annan hjälppersonal , liksom det är för användning i HTML eller kommentar formulär .
3
Använd metodbeskrivningen . Denna meta - taggen har ingen tagg namn : Det är helt enkelt den kommentar som kommer före de andra taggar " " /*** Beräknar lutningen på en linje . . * /" "
4
Införliva parameterbeskrivningar . Dessa betecknas med @ param meta-taggar , vilket bör följas av en parameter namn och beskrivning . " " /*** Beräknar lutningen på en linje . ** @ Param p1 Första punkten som beskriver linjen * @ param p2 andra punkt som beskriver linjen * /""
5
returvärde beskrivningar . Detta betecknas med @ return meta - taggen och bör följas av en beskrivning av returvärdet . " " /*** Beräknar lutningen på en linje . ** @ Param p1 Första punkten som beskriver linjen * @ param p2 andra punkt som beskriver linjen * @ return linjens lutning som en float * /" "
6
Lägg attribution taggar . Taggarna tillskriver koden till en viss författare . " " /*** Beräknar lutningen på en linje . ** @ Författare Jack Smith * @ param p1 Första punkten som beskriver linjen * @ param p2 andra punkt som beskriver linjen * @ return linjens lutning som en float * /" "
7
generera HTML- dokumentationen . Om du inte använder en IDE eller om du bara vill göra det manuellt , kan du köra javadoc kommandoraden program från ditt projekt katalog . Ange utdata katalogen med - d switch och passerar det en lista över . Java -filer ( oftast som ett wildcard ) . " " Javadoc - d docs * . Java " "
