Javadoc ist ein Hilfsprogramm, welches durch den Quelltext geht, die Deklarationen parsiert und die Dokumentation herauszieht. Daraus generiert das Tool eine Beschreibung, die im Normalfall unter Verwendung des Standard-Doclet's als HTML-Seite herauskommt. Diese Dokumentation beschreibt die Klassen (auch innere), deren Vererbung, Methoden und Variablen, die Interfaces und Konstruktoren. Seit Java 1.2 hat man nun die Möglichkeit über das Konzept der Doclets die Ausgabe nach den eigenen Bedürfnissen anzupassen.
Um mit Javadoc eine Dokumentation zu erzeugen, gibt man
dem Programm als Parameter den Dateinamen des Quelltextes der zu kommentierenden
Klasse, den Paketnamen oder auch mehrere als Kommandozeilenoption mit.
In der besonders gekennzeichneten Kommentarumgebung
/**
* A class that represents ...
*/
können sowohl die normalen HTML-Tags und als auch eigene Tags von Javadoc verwendet werden, dies gilt aber nur wenn man das Standarddoclet benutzt. Gleiches gilt auch für die Parameter von Javadoc..
Hier eine Auflistung der wichtigsten Tags:
| Tag und Beschreibung |
| @see Klassenname |
| @see Klassenname#Methodenname |
| @see Ausgeschriebener Klassenname |
| @see Ausgeschriebener Klassenname#Methodenname |
| @version Versionstext |
| @author Autor |
| @return Rückgabetext |
| @param Parametername Parametertext |
| @exception Exception-Klassenname Exceptiontext |
| @throws Exception-Klassenname Exceptiontext |