Dokumentieren Sie die Methode mult. Sie implementiert die Multiplikation zweier Zahle und gibt das Ergebnis aus. Als Dokumentationstext für die Sematik der Methode genügt ein Text wie „multipliziert zwei Werte“.

Achten Sie auf die Notation von:

• Syntax des Dokumentationskommentars
• Dokumentation der Methode mit „multipliziert zwei Werte“
• Dokumentation der Eingabewerte
• Dokumentation des Ausgabewerts

public double mult(double a, double b) {
   double c = a* b;
return c;
}

Die Antwort ist bei der nächsten Frage zu finden (URL rechts unten)

Nennen Sie mindesten zwei Eigenschaften der Dokumentationskommentare die man beim Generieren der Kommentare mit javadoc wahlweise Erzeugen oder Unterdrücken kann.

Die Antwort ist bei der nächsten Frage zu finden (URL rechts unten)

Antwort zu Frage 1: Dokumentationskommentare

/**
* multipliziert zwei Werte
* @param a erster Faktor
* @param b zweiter faktor
* @return Ergebnis der Multiplikation
*/
public double mult(double a, double b) {
   double c = a* b;
return c;
}

Ein gutes Programm sollte sinnvolle Kommentare enthalten.
Welche 2 Arten von Kommentaren gibt es in Java-Programmen?

Geben Sie jeweils einekurze Erklärung mit einem kleinen Beispiel und unter Angabe eines ange­messenen Einsatzzweckes! (Hier ist nicht nach Dokumentationskommentaren für Schnittstellen gefragt)

Die Antwort ist bei der nächsten Frage zu finden (URL rechts unten)

Antwort zu Frage 2: Eigenschaften von Dokumentationskommentaren

• Autorinformation
• Versionsinformation
• private Attribute und Methoden

Was ist an Dokumentationskommentaren besonders im Vergleich zu normalen Kommentaren?

Die Antwort ist bei der nächsten Frage zu finden (URL rechts unten)

Antwort zu Frage 3: Kommentieren von Javaprogrammen

Zeilenkommentare

// Dies ist ein Zeilenkommentar

Mehrzeilige Kommentare

/*
Dies ist ein
mehrzeiliger Kommentar
*/

Antwort zu Frage 4.: javadoc

Sie werden von javadoc aus dem Quellcode ausgelesen und für eine automatisch generierte Dokumentation verwendet.