JavaDoc Trivial

🚧

Diese Seite befindet sich in Bearbeitung

🚧

Trivales JavaDoc

Alle nicht-privaten (öffentliche (public), geschützte (protected) und paket-privaten (package-private, ohne Modifikator)) Klassen, Enums, Interfaces, Methoden, Konstanten und Attribute stets ein aussagekräftiger JavaDoc-Kommentar vorhanden sein muss. Diese Kommentare dienen dazu, Entwicklern und Anwendern die Funktionsweise und Nutzung der Software zu erklären. Dabei ist es unzureichend, lediglich sinnlose, formale oder triviale Kommentare zur Erfüllung von Checkstyle-Vorgaben anzugeben, ohne die Methode oder Funktion angemessen zu dokumentieren, da dies keine hilfreiche Erklärung darstellt.

Negativbeispiel:

/**
 *
 * @return name
 */
public String getName() {
    return this.name;
}

Positivbeispiel:

/**
 * Gets the full name of the person, i.e. the first name(s) separated by whitespaces, followed by a whitespace and the last name.
 * This method returns {@code null} if no name was set.
 *
 * @return the full name of the person or {@code null} if no name was set
 */
public String getName() {
    return this.name;
}