Javadoc

Fra Wikipedia, den frie encyklopedi
Gå til: navigasjon, søk

Javadoc er et dataprogramverktøy fra Sun Microsystems brukt til å generere API-dokumentasjon fra Java-kode til HTML-format. Javadoc er industristandarden for å dokumentere Java-kode.

Javadoc-tagger[rediger | rediger kilde]

Utviklere bruker spesielle kommentarer og Javadoc-tagger når de dokumenterer kildekoden. En kommentar i koden som starter med /** er starten på en Javadoc-kommentar, og vil bli inkludert i den genererte HTML-en. En Javadoc-tag[1] begynner med "@" (krøllalfa). Eksempler på tagger er gitt i den følgende tabellen.

Tag JDK Beskrivelse
@author 1.0 Navnet på utvikleren
@deprecated 1.0 Merker en klasse, metode eller felt som utdatert eller ikke i bruk.
@exception 1.0 Dokumenterer et unntak (exception) som blir kastet av en metode – se også @throws.
@param 1.0 Angir en parameter i en metode. Det er én @param for hver parameter.
@return 1.0 Dokumenterer returverdien. Denne taggen skal ikke brukes for konstruktører eller metoder med returtype void.
@see 1.0 Dokumenterer en forbindelse til en annen metode eller klasse.
@since 1.1 Dokumenterer når en pakke, klasse, metode eller felt ble lagt til.
@throws 1.2 Dokumenterer et unntak (exception) som blir kastet av en metode. Er synonymt med @exception.
@version 1.0 Angir versjonsnummeret til en pakke eller klasse.

Eksterne lenker[rediger | rediger kilde]

Referanser[rediger | rediger kilde]

  1. ^ Javadoc tags i JavaSE 6