Javadoc-Übersicht

Nutze Javadoc-Kommentare, um Java-Klassen, Methoden und Felder konsistent zu dokumentieren.

1) Was ist Javadoc?

Javadoc ist ein Tool, das Kommentare aus Java-Quellcode liest und daraus HTML-Dokumentation erzeugt.

2) Javadoc-Beispiel aus dem Code

/**
 * Renders the ArrayMap view with current entries and size metadata.
 *
 * @param model model used to expose view attributes
 * @return the ArrayMap view name
 */
@GetMapping("/arraymap")
public String arrayMap(Model model) {
    model.addAttribute("entries", arrayMapService.getEntries());
    model.addAttribute("size", arrayMapService.getSize());
    model.addAttribute("capacity", arrayMapService.getCapacity());
    return "arraymap";
}

3) Häufige Javadoc-Tags

Tag	Zweck	Beispiel
`@param`	Beschreibt einen Methodenparameter.	`@param size the number of items`
`@return`	Beschreibt den Rückgabewert.	`@return total count`
`@throws`	Listet mögliche Exceptions auf.	`@throws IllegalArgumentException if size < 0`
`@deprecated`	Markiert eine veraltete API.	`@deprecated use newMethod()`
`@see`	Verweist auf verwandte Klassen oder Methoden.	`@see java.util.List`

4) Vorteile von Javadoc

Erzeugt eine konsistente, gut navigierbare Dokumentation.
Definiert klare API-Vertraege und Nutzungshinweise.
Hilft Teams beim schnelleren Onboarding.
Lässt sich gut mit IDEs und Build-Tools integrieren.

5) Generierte Dokumentation

Öffne die generierte HTML-Dokumentation aus dem Build-Output.

Javadoc öffnen

Öffnet in einem neuen Tab.