Javadoc
Fra Wikipedia, den frie encyklopedi
Javadoc er et dataprogram-verktøy fra Sun Microsystems til å generere API dokumentasjon fra Java-kode til HTML-format. Javadoc er industri-standarden for å dokumentere Java-klasser.
[rediger] Javadoc tagger
Utviklere bruker spesielle kommentar-stiler og Javadoc tagger når de dokumenterer kildekoden. En kommentar i Java som starter med /** er starten på en Javadoc-kommentar som vil bli inkludert i den genererte HTML'en. En Javadoc tag begynner med "@" (alfakrøll). Noen eksempler på tagger er gitt i den følgende tabellen.
-
Tag Beskrivelse @author Navnet på utvikleren @deprecated Markerer en metode som deprecated/ikke i bruk. @exception Dokumenterer et unntak (exception) som blir kastet av en metode — se også @throws. @param Angir parameterne til en metode. Obligatorisk for hver parameter. @return Dokumenterer retur-verdien. Denne taggen skal ikke brukes for konstruktorer eller meteoder med returntype void. @see Dokumenterer en forbindelse til en annen metode eller klasse. @since Dokumenterer når en metode ble lagt til en klasse. @throws Dokumenterer et unntak (exception) som blir kastet av en metode. Et synonym for @exception introdusert i Javadoc 1.2. @version Angir versjonsnummeret til en klasse eller metode.
