3.4 Die API-Dokumentation
 
Die wichtigste Informationsquelle für Programmierer ist die API-Dokumentation von Sun. Über unseren Punkt können wir dort entnehmen, dass dieser eine Funktion setLocation() besitzt, eine Variable x und y definiert und einen Konstruktor anbietet, der zwei Ganzzahlen annimmt.
Die Dokumentation muss extra von der Sun-Seite bezogen werden (http://java.sun.com/docs/) und gehört nicht zu einer Standardinstallation einer Laufzeitumgebung dazu. Wer permanente Internetverbindung besitzt, kann die Dokumentation auch online unter http://java.sun.com/j2se/1.5.0/docs/api/index.html lesen.
Die Sun-Dokumentation in der HTML-Form hat einen Nachteil, der sich im Programmieralltag bemerkbar macht: Die Dokumentation lässt sich nur ungenügend durchsuchen, da die Webseiten statisch sind. Wenn wir einfach nach Methoden suchen wollen, die auf »listener« enden, geht das so nicht. Hier kommt die Arbeit des Franzosen Franck Allimant ins Spiel. Er übersetzt regelmäßig die HTML-Dokumentation von Sun in das Windows-Hilfe-Format HTMLHelp und WinHelp. Unter http://www.allimant.org/javadoc/javadoce.html lassen sich die komprimierten Hilfe-Dateien beziehen. Unter anderem liegt auf der Webseite auch die Sprach- und JVM-Spezifikation sowie die API-Dokumentation der Enterprise Edition und der Servlets im Speziellen. Der Screenshot zeigt die Windows-Hilfe.
 Hier klicken, um das Bild zu Vergrößern
|