JavaDoc

Question 1

Was ist JavaDoc

Answer 1

automatisch aus dem Quellcode generierte Dokumentationen erstellt. Es ermöglicht Entwicklern, Kommentare und Anmerkungen zu ihren Klassen, Methoden und Variablen hinzuzufügen, um die Verwendung und Funktionalität des Codes zu erklären.

Question 2

Erklären können, wo im Programm JavaDoc-Kommentare
gebraucht werden und wie sie aussehen müssen

Answer 2

JavaDoc-Kommentare werden direkt vor Klassen, Methoden oder Variablen geschrieben, um deren Funktionalität zu dokumentieren. Sie beginnen mit /** und enden mit */. Innerhalb des Kommentars können verschiedene Tags wie @param, @return oder @throws verwendet werden, um zusätzliche Informationen über Parameter, Rückgabewerte oder Ausnahmen bereitzustellen.

Question 3

Erklärung von
* Sonderfällen (z.B. bei inkorrekten Parametern)
* Workarounds (alias Hacks)
* Design-Entscheidungen (warum wird eine bestimmte Klasse
verwendet?)

Answer 3

• Sonderfälle: Abweichende Parameter oder Bedingungen, die zu Fehlern führen können.
• Workarounds: Temporäre Lösungen oder Umgehungen für Probleme ohne direkte Lösung.
• Design-Entscheidungen: Auswahl einer Klasse zur Erfüllung von Anforderungen oder Optimierung der Leistung.

Question 4

Javadoc

Answer 4

Aussagefähige Dokumentation benötigt manuell eingegebene
Kommentare der Software-Entwickler
* Die Dokumentation wird durch Schlüsselwörter in den Kommentaren
strukturiert

Question 5

Typische Klassenkommentare

Answer 5

Autor, Version, Beschreibung Aufgabe, Verweis auf andere Klassen

Question 6

Typische Methodenkommentare

Answer 6

Beschreibung der Aufgabe, der Parameter und des
Rückgabewertes

Question 7

Worüber gibt Javadoc keine Informationen

Answer 7

Keine Information über Details der Implementation

Question 8

Was kommentieren

Answer 8

• Bündel von Paketen
• Pakete
• Klassen
• Felder
• Konstruktoren
• Methoden

Question 9

Wann wird der Rückgabewert nicht beschrieben?

Answer 9

außer für void und bei Konstruktoren

Question 10

Wie werden geworfene Ausnahmen (Exception) dokumentiert

Answer 10

@throws

Question 11

Querverweis auf z.b. image

Answer 11

@see

Question 12

Javadoc Zusammenfassung

Answer 12

• Ausdrucksstarke verlinkte Dokumentation durch Kommentare
  mit Schlüsselwörtern
• Javadoc nutzt Schlüsselworter, die mit „@“ beginnen, aber
  immer nur im Kommentarbereich
• Kommentare werden vom Compiler nicht ausgewertet