Javadoc er eit dataprogram-verktøy frå Sun Microsystems til å generera API dokumentasjon frå Java-kode til HTML-format. Javadoc er industri-standarden for å dokumentera Java-klassar.
Utviklarar nyttar spesielle kommentar-stilar og Javadoc taggar når dei dokumenterer kjeldekoda. Ein kommentar i Java som startar med /** er starten på ein Javadoc-kommentar som vil verte inkludert i den genererte HTML'en. Ein Javadoc tag byrjar med "@" (krøllalfa). Nokre eksempel på taggar er gjeve i den følgjande tabellen.
Tag | Beskriving |
---|---|
@author | Namnet på utviklaren |
@deprecated | Markerer ein metode som ikkje i bruk. |
@exception | Dokumenterer eit unntak som vert kasta av ein metode — sjå òg @throws. |
@param | Gjev parametra til ein metode. Obligatorisk for kvart parameter. |
@return | Dokumenterer retur-verdien. Denne taggen skal ikkje brukast for konstruktorar eller metodar med returntype void. |
@see | Dokumenterer ein samanheng med ein annan metode eller klasse. |
@since | Dokumenterer når ein metode vart lagt til ein klasse. |
@throws | Dokumenterer eit unntak som blir kasta av ein metode. Eit synonym for @exception introdusert i Javadoc 1.2. |
@version | Gjev versjonnummeret til ein klasse eller metode. |