Um die Dokumentation des JDKs nutzen zu können, muss diese auch installiert sein. Falls du die Java-Dokumentation noch nicht auf deinem PC installiert hast, kannst du in dem Beitrag Wie installiere ich Java 7 – Installation der Java-Dokumentation die Installationsschritte noch einmal nachlesen.
Die Java-Dokumentaion des JDK wird über einen Browser (Firefox, Internet Explorer, Chrome, Safari) betrachtet und ist eine Ansammlung von vielen hundert HTML-Dateien.
Dies hat viele Vorteile, wie bspw. eine übersichtliche Darstellung der Dokumentation.
Für einen schnellen Zugriff auf die Startseite der Java-Dokumentation bietet sich das Verwenden eines Lesezeichens an.
Es ist auch zu empfehlen, weitere Lesezeichen für wichtige Abschnitte der Java-Dokumentation zu verwenden.
Die Startseite der Java-Dokumentation ist die index.html Datei in dem docs-Ordner des JDK-Installationsverzeichnisses.
Von der Startseite aus können alle Unterseiten erreicht werden. Sie enthält neben den internen Links auch viele nützliche externe Verweise.
In der folgenden Abbildung ist die Startseite der Java-Dokumentation dargestellt. Über den rot markierten Link „Java SE API“ in der unteren rechten Ecke gelangt man zu der sehr hilfreichen API-Dokumentation des JDK.
Die Startseite der Java-Dokumentation des JDK, die API-Dokumentation ist über den markierten Link erreichbar
Die API-Dokumentation des Java-JDK
Für Java-Entwickler ist die API-Dokumentation der wichtigste Abschnitt der Java-Dokumentation.
Sie kann über den oben beschriebenen Link „Java SE API“ auf der Stratseite der Java-Dokumentation oder durch direkten Aufruf der folgenden Datei gestartet werden:
JDK-Installation\docs\api\index.html
Der Begriff API steht für Application Programming Interface, auf Deutsch ist es die Schnittstelle für die Prgrammierung von Anwendungen.
Die API-Dokumentation wurde automatisch von dem Software-Dokumentationswerkzeug Javadoc erstellt. Javadoc generiert aus Java-Quelltexten automatisch HTML-Dokumentationsdateien und ist Bestandteil des JDK.
Die gesamte API-Dokumentation wird mit Hilfe von 3 Frames dargestellt. Der Java-Entwickler kann sich aufgrund diese Darstellungsweise sehr effektiv Informationen zu allen öffentlichen Paketen, Klassen, Methoden und Variablen anzeigen lassen.
Die drei Frames enthalten folgende Informationen:
- Paketframe – Der Frame 1 oben links enthält eine Auflistung aller Pakete des JDK. Mit einem Klick auf einen der angegebenen Paket-Verweise, wird im Frame direkt darunter die Liste der zugehörigen Klassen, Interfaces und Exceptions des Pakets angezeigt.
- Klassenframe – Der Frame 2 unten links enthält eine Liste von Verweisen auf alle Klassen, Interfaces, Enums, Errors und Exceptions des ausgewählten Pakets. Mit einem Klick auf einen der angegebenen Verweise, wird im Frame direkt rechts daneben eine Beschreibung zu der jeweiligen Klassen, Exception usw. angegeben.
- Beschreibungsframe – Der Frame 3 erstreckt sich über die komplette rechte Seite und enthält die Beschreibung der jeweiligen Klasse, Interface, Enum, Error und Exception. Die Beschreibung enthält Vererbungsinformationen, eine allgemeine Beschreibung der Klasse und detaillierte Informationen über die Konstriktoren, Methoden, Variablen und Konstanten.
In der folgenden Abbildung wird die Beschreibung der Methoden addNotify, paint und update der Klasse Canvas des Pakets java.awt dargestellt. Die drei Frames sind mit roten Zahlen gekennzeichnet.
Die API-Dokumentation des JDK, sie ist in drei Bereiche unterteilt 1-Pakete, 2-Klassen, Interfaces, Exceptions und 3-Beschreibung
In vielen Java-Entwicklungsumgebungen kann die Java-Dokumentation direkt beim Programmieren dargestellt werden. Dies ist eine sehr hilfreiche Funktion, so kann man bspw. aus der Java-IDE direkt auf die Dokumentation von Klassen und Methoden zuzugreifen.
In folgedem Beitrag erfährst die welche Java-Entwicklungsumgebungen es gibt.
Comments 1
Pingback: Der Einstieg in die Welt der Java-Programmierung -