Javadoc

Javadoc screenshot.png

Javadoc er en dokumentasjonsgenerator , som består av Java - kildekode automatisk HTML opprettet -Dokumentationsdateien. I likhet med Java ble Javadoc utviklet av Sun Microsystems og er en del av Java Development Kit fra versjon 2 og utover .

Dokumentasjonen kan berikes med spesielle kommentarer i kildeteksten. Her brukes koder som tjener, f.eks. B. å beskrive grensesnitt, klasser, metoder og felt mer detaljert. I tillegg til standardutdata i HTML, er alternative utganger mulig ved bruk av spesielle dokler . Dette er en enkel form for literate programmering .

funksjonalitet

Når du ringer, mottar Javadoc alternativer med informasjon om Java-kildekoden som skal dokumenteres. Javadoc analyserer kildekoden for alle Javadoc-kommentarer (starter med /**) og de følgende ikke-lokale symbolene. Hver Javadoc-kommentar skannes etter Javadoc-koder den inneholder (starter med @eller {@). Disse inneholder metadata med et dokumentkarakter om det respektive symbolet. Ved hjelp av såkalte taglets kan det eksisterende Javadoc tag-vokabularet utvides. Dokollen genererer deretter utdataene. Standarddoklen genererer utdata i HTML. Men det er også andre doclets for å lage dokumentasjonen i andre formater som RTF , XML , PDF , FrameMaker , Windows Help og noen få flere.

Eksempel på kildekode

/**
 * Ein Hello-World-Programm in Java.
 * Dies ist ein Javadoc-Kommentar.
 *
 * @author John Doe
 * @version 1.0
 */
public class Hello {
    /**
     * Hauptprogramm.
     *
     * @param args Kommandozeilenparameter
     */
    public static void main(String[] args) {
        System.out.println("Hallo Welt!");
    }
}

Eksempel på utdata

Et eksempel på utdata fra Javadoc er Java API-dokumentasjonen fra Oracle (se nettlenker ), som ble opprettet ved hjelp av Javadoc.

Oversikt over Javadoc-kodene

Dag og parametere produksjon Bruk i siden
@author Etternavn Beskriver forfatteren. Klasse, grensesnitt
@version versjon Oppretter en versjonsoppføring. Maksimalt en gang per klasse eller grensesnitt. Klasse, grensesnitt
@since jdk versjon Siden da har funksjonaliteten eksistert. Klasse, grensesnitt, forekomstvariabel, metode
@see henvisning Oppretter en lenke til et annet element i dokumentasjonen. Klasse, grensesnitt, forekomstvariabel, metode
@serial Beskriver de serielle dataene til et Serializableobjekt. klasse
@serialField Dokumenterer et felt av et Serializableobjekt. Klasse, metode
@param navnebeskrivelse Parameterbeskrivelse av en metode. metode
@return beskrivelse Beskrivelse av returverdien til en metode. metode
@exceptionklassenavn beskrivelse
@throwsklassenavn beskrivelse		 Beskrivelse av et unntak som kan kastes med denne metoden. metode
@deprecated beskrivelse Beskriver en foreldet metode som ikke lenger skal brukes. Bør alltid brukes med @Deprecatedmerknaden fra Java 5.0 og utover. metode
{@inheritDoc} Kopierer beskrivelsen fra den overskrevne metoden. Overstyrende metode 1.4.0
{@link reference} Koble til et annet symbol. Klasse, grensesnitt, forekomstvariabel, metode
{@linkPlain reference} Koblingen vises i standardtekst i stedet for kildetekstsettet. Klasse, grensesnitt, forekomstvariabel, metode 1.4.0
{@value} Returnerer verdien av et konstant felt. Statisk felt 1.4.0
{@docRoot} Returnerer den absolutte banen til hovedkatalogen. Pakke, klasser, felt, metoder
{@code} Formaterer tekst til bokstaven med kildetekstsettet (tilsvarer <code> ) og undertrykker tolkningen av HTML- eller Javadoc-kodene den inneholder. Klasse, grensesnitt, forekomstvariabel, metode 5.0
{@literal} Indikerer bokstavelig tekst og undertrykker tolkningen av inneholdte HTML- eller Javadoc-koder. Klasse, grensesnitt, forekomstvariabel, metode 5.0

For å bruke symbolet " @" uten å starte en Javadoc-tag, kan HTML-tegnkoden " &#064;" brukes. Dette er nyttig, for eksempel i et kodeeksempel i en Javadoc-kommentar for å bruke merknader som @starter med " " som en Javadoc-tag .

Lignende verktøy

weblenker