Fachkonzept - Klassendokumentation

Klassendokumentation lesen

Java stellt eine mächtige Klassenbibliothek von mehreren tausend Klassen zur Verfügung. Dazu gehören z.B. Klassen wie String oder Random. Dabei ist es natürlich unmöglich alle Klassen zu kennen. Es ist deshalb wichtig sich in der Dokumentation der Klassen zurechtzufinden. Auch Greenfoot stellt einige Klassen bereit, die genau wie die Java-eigenen Klassen dokumentiert sind.

Die Dokumentation der Java-eigenen Klassen findet man leicht über eine Suchmaschine, z.B. über die Suchbegriffe "String Java". Alternativ kann man die Dokumentation über das Hilfe-Menü von BlueJ oder Greenfoot öffnen. Die Greenfoot-Dokumentation öffnet man am einfachsten über das Hilfemenü in Greenfoot.

Der Aufbau einer solchen Dokumentation soll hier am Beispiel der Klasse String gezeigt werden.

Um Struktur in die große Zahl an Klassen zu bringen und um Namenskonflikte zu vermeiden, sind Klassen normalerweise in sogenannten Paketen organisiert. Den Namen des Pakets findet man oben in der Dokumentation und teilweise auch vor dem Klassennamen. Um eine andere Klasse zu benutzen, muss man das Paket noch vor der eigenen Klassendefinition importieren.

import java.lang.*;      // Import aller Klassen des Pakets oder:
import java.lang.String; // Import der Klasse String
class MeineKlasse {
   ...

Alternativ kann man die Importanweisung weglassen, muss dann aber immer den Paketnamen vor den Klassennamen stellen.

java.lang.String s = "Hallo";

Dir wird auffallen, dass Du das so nie geschrieben hast, es aber dennoch funktioniert. Das liegt daran, dass java.lang eine Ausnahme darstellt, da das Paket sehr wichtige Klassen enthält und automatisch immer importiert wird.

Danach folgt der Name der Klasse und die Klassenhierarchie. Oberste Klasse ist immer Object, die beim Schreiben einer Klasse automatisch Oberklasse ist, falls keine andere Oberklasse angegeben wird.

Nach einigen allgemeinen Bemerkungen zur Klasse folgen Zusammenfassungen zu Attributen, Konstruktoren und Methoden. Standardmäßig werden nur öffentlich zugreifbare Elemente angezeigt, so dass gewöhnliche Attribute hier meist nicht stehen, da sie üblicherweise als privat definiert werden. Klickt man auf eines dieser Elemente springt man weiter unten auf die Seite, wo z.B. genau erklärt wird wie eine bestimmte Methode anzuwenden ist.

Konkret sieht die Dokumentation der Klasse String folgendermaßen aus.

Klassenmethoden erkennt man daran, dass in der Signatur static vorangestellt ist. Man ruft diese Methoden also gemäß dem Muster Klassenname.methodenname() auf. In der Klasse String gibt es bspw. die Klassenmethode / statische Methode valueOf(...), die man also z.B. durch String.valueOf(5) aufruft:

Klassendokumentation erzeugen

Der Aufbau der Klassendokumentationen ist dabei unabhängig vom Entwickler, da im Normalfall die Java-eigenen Werkzeuge benutzt werden, um diese zu generieren. Das Tool javadoc generiert dazu aus den mit speziellen Kommentaren versehenen Klassen die Dokumentation. Optische Unterschiede resultieren in erster Linie aus unterschiedlichen Java-Versionen. Auf die Syntax der Kommentare soll hier nicht eingegangen werden. Wer die eigenen Klassen entsprechend dokumentieren möchte, findet aber z.B. bei Wikipedia eine knappe, aber gute Übersicht. In BlueJ und Greenfoot muss man dann nur noch im Editor oben rechts von "Quellcode" auf "Dokumentation" umstellen, um die Dokumentation zu generieren und angezeigt zu bekommen.