Dokumentationsansicht

Die Dokumentationskommentare

vor der Klassen- bzw. Methodenkopfzeile

werden geschrieben, um mit Hilfe des javadoc-Tools eine

Dadurch ruft BlueJ eine interne Version des Programms javadoc

auf, das

aus den Dokumentationskommentaren eine HTML-Seite generiert. Diese ist

so formatiert, wie die offizielle Java-API-Dokumentation (diese wurde

mit dem selben Tool erstellt).

Nach den Angaben im Klassenkommentar wird die Kurzbeschreibung aller

Methoden aufgelistet.

Weiter unten folgt noch zu jeder Methode eine Detailbeschreibung, wo

auch die komplette Methodenkopfzeile sowie der vollständige

Beschreibungstext angegeben ist.

Ergänze die folgende Zusammenfassung:

• Durch das Umschalten von Quellcode auf Dokumentationsansicht wird das Programm (Tool) ausgeführt.

• Dieses Programm erzeugt aus den Dokumentationskommentaren eine -Seite

• Die Formatierung ist die selbe, wie bei der offiziellen Java--Dokumentation

• Nach dem Namen und der Kopfzeile der Klasse folgt die allgemeine Beschreibung. Anschließend stehen die Information aus dem

  @version

  @author

  @date

  @description
  -Tag gefolgt von der Information aus dem
  @version

  @author

  @date

  @description
  -Tag.

• Darauf folgt die Kurzbeschreibung aller .

• In der Detailbeschreibung zu jeder Methode steht die sowie der vollständige Beschreibungstext.