3.6 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 ist nicht Teil der Standardinstallation einer Laufzeitumgebung – dafür ist die Hilfe zu groß. Wer über eine permanente Internetverbindung verfügt, kann die Dokumentation auch online unter http://java.sun.com/j2se/1.5/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 lässt sich nicht einfach nach Methoden suchen, die auf »listener« enden. Einige Entwickler haben daher die Sammlung der HTML-Dateien in ein anderes Format übergeführt, das diese Suche ermöglicht. Unter Windows ist das Hilfe-Format HTML-Help (CHM) und WinHelp verbreitet. Franck Allimant übersetzt regelmäßig die HTML-Dokumentation von Sun in das Windows-Hilfe-Format HTML-Help und WinHelp. Unter http://java-tutor.com/go/allimant 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.
 Hier klicken, um das Bild zu Vergrößern
Abbildung 3.3
API-Dokumentation mit der Windows-Hilfe
|