API Dokumentation (Java): Unterschied zwischen den Versionen

Aus Byte-Welt Wiki
Zur Navigation springenZur Suche springen
K (→‎Help)
K
 
(25 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
Das Java Runtime Environment (kurz [[JRE]]) bietet viele tausend [[Klasse_(Java)|Klassen]], und nochmehr [[Methode_(Java)|Methoden]]. Es ist nur schwer möglich, den Überblick über soviele Informationen zu behalten, wenn man nur den Quellcode zur verfügung hat.
+
Das Java Runtime Environment (kurz [[JRE]]) bietet viele tausend [[Klasse_(Java)|Klassen]], und nochmehr [[Methode_(Java)|Methoden]]. Es ist nur schwer möglich, den Überblick über so viele Informationen zu behalten, wenn man nur den Quellcode zur Verfügung hat.
−
 
+
[[Datei:API-Doc_Java9.png|400px|thumb|right|API-Doc Java 9 in a window]]
 
Deshalb wurde die "API Dokumentation" geschrieben.
 
Deshalb wurde die "API Dokumentation" geschrieben.
  
−
Die API Dokumentation, kurz API, kann man bei Sun [http://java.sun.com/] herunterladen, für Java 1.5 gibt es auch eine Onlineversion [http://java.sun.com/j2se/1.5.0/docs/api/index.html].
+
Die API Dokumentation, kurz API-Doc (manchmal auch nur API), kann man bei Oracle [http://www.oracle.com/technetwork/java/javase/downloads/index.html herunterladen]. Für die aktuelle Java-Version gibt es immer auch eine Onlineversion der Java-API Dokumentation.
 +
*[https://docs.oracle.com/javase/7/docs/api/ Java 7 API-Documentation]
 +
*[https://docs.oracle.com/javase/8/docs/api/ Java 8 API-Documentation]
 +
*[https://docs.oracle.com/javase/9/docs/api/index.html?overview-summary.html Java 9 API-Documentation]
 +
*[https://docs.oracle.com/javase/10/docs/api/index.html?overview-summary.html Java 10 API-Documentation]
 +
*[https://docs.oracle.com/en/java/javase/11/docs/api/index.html Java 11 API-Documentation]
 +
*[https://docs.oracle.com/en/java/javase/12/docs/api/index.html Java 12 API-Documentation]
 +
*[https://docs.oracle.com/en/java/javase/13/docs/api/index.html Java 13 API-Documentation]
 +
*[https://docs.oracle.com/en/java/javase/14/docs/api/index.html Java 14 API-Documentation]
 +
*[https://docs.oracle.com/en/java/javase/15/docs/api/index.html Java 15 API-Documentation]
 +
*[https://docs.oracle.com/en/java/javase/16/docs/api/index.html Java 16 API-Documentation]
 +
*[https://docs.oracle.com/en/java/javase/17/docs/api/index.html Java 17 API-Documentation]
  
 
== Aufbau der API Dokumentation ==
 
== Aufbau der API Dokumentation ==
−
Die API besteht aus 3 Fenstern:
+
[[Datei:API-Doc_window.png|400px|thumb|right|API-Doc Java 8 in a window]]
 +
Die API-Doc besteht aus 3 Fenstern:
 
* Oben links sind sämtliche [[Package_(Java)|Packages]] aufgeführt
 
* Oben links sind sämtliche [[Package_(Java)|Packages]] aufgeführt
 
* Unten links sind die [[Klasse_(Java)|Klassen]] des aktuell gewählten Packages aufgelistet
 
* Unten links sind die [[Klasse_(Java)|Klassen]] des aktuell gewählten Packages aufgelistet
 
* Rechts ist ein Multifunktionsfenster
 
* Rechts ist ein Multifunktionsfenster
  
−
Zusätzlich gibt es einige Demonstrationen und Tutorials [http://java.sun.com/j2se/1.5.0/docs/#demos] in der API Dokumentation zu finden.
+
Zusätzlich gibt es einige Demonstrationen und Tutorials in der API Dokumentation zu finden.
  
 
== Das Multifunktionsfenster ==
 
== Das Multifunktionsfenster ==
−
Das Fenster auf der rechten Seite der API hat 8 Funktionen, welche in den Leisten oben und unten ausgewählt werden können. Die Funktionen sind:
+
Das Fenster auf der rechten Seite der API-Doc hat 8 Funktionen, welche in den Leisten oben und unten ausgewählt werden können. Die Funktionen sind:
 
===Overview===
 
===Overview===
−
Eine Liste aller verfübgarer Packages. Auf der linken Seite der Tabelle befindet sich der Name des Packages, rechts eine Beschreibung, für was die Klassen des Packages verwendet werden.
+
Eine Liste aller verfübgarer [[Package_(Java)|Packages]]. Auf der linken Seite der Tabelle befindet sich der Name des Packages, rechts eine Beschreibung, für was die Klassen des Packages verwendet werden.
  
 
===Package===
 
===Package===
Zeile 22: Zeile 34:
 
Elemente können [[Interface_(Java)|Interfaces]], [[Klasse_(Java)|Klassen]], [[Exception_(Java)|Exceptions]], [[Error_(Java)|Errors]], [[Enum_(Java)|Enumerationen]] oder [[Annotation_(Java)|Annotations]] sein.
 
Elemente können [[Interface_(Java)|Interfaces]], [[Klasse_(Java)|Klassen]], [[Exception_(Java)|Exceptions]], [[Error_(Java)|Errors]], [[Enum_(Java)|Enumerationen]] oder [[Annotation_(Java)|Annotations]] sein.
  
−
===Class===
+
==Class==
−
Diese Ansicht wird verwendet um Elemente eines Packages genauer zu beschreiben. Hauptsächlich sind dies Klassen, aber auch Interfaces, Enumerationen o.ä. wird hier angezeigt.
+
Diese Ansicht wird verwendet um Elemente eines Packages genauer zu beschreiben. Hauptsächlich sind dies [[Klasse|Klassen]], aber auch Interfaces, Enumerationen o.ä. wird hier angezeigt.
  
 
Diese Ansicht besteht aus 3 Sektionen:
 
Diese Ansicht besteht aus 3 Sektionen:
 
* '''Beschreibung''': Eine Beschreibung des aktuellen Elementes. Dies beinhaltet die Vererbungshierarchie und einen längeren Text.
 
* '''Beschreibung''': Eine Beschreibung des aktuellen Elementes. Dies beinhaltet die Vererbungshierarchie und einen längeren Text.
−
* '''Zusammenfassung''': Eine Liste aller [[Innere_Klasse_(Java)|inneren Klassen]], [[Variable|Variablen]], [[Konstruktor_(Java)|Konstruktoren]] und Methoden.
+
* '''Zusammenfassung''': Eine Liste aller [[Klasse#Geschachtelte_.28innere.29_Klassen|innere Klassen]], [[Variable|Variablen]], [[Konstruktor_(Java)|Konstruktoren]] und Methoden.
 
* '''Details''': Für jeden Eintrag in der Zusammenfassung gibt es noch eine detailierte Beschreibung.
 
* '''Details''': Für jeden Eintrag in der Zusammenfassung gibt es noch eine detailierte Beschreibung.
  
 
===Use===
 
===Use===
−
Use zeigt an, wo ein Element (Klasse, Interface, Enumeration, etc.) benutzt wird. Sortiert nach Packages wird gezeigt, wer von dem Element erbt, wer das Element als Variable benutzt, wo das Element als Argument oder Rückgabewert einer Methode vorkommt, etc.
+
Use zeigt an, wo ein Element (Klasse, Interface, [[Enum (Java)|Enumeration]], etc.) benutzt wird. Sortiert nach [[Package|Packages]] wird gezeigt, wer von dem Element erbt, wer das Element als Variable benutzt, wo das Element als [[Argument]] oder Rückgabewert einer Methode vorkommt, etc.
  
 
===Tree===
 
===Tree===
−
Hier wird die komplette Vererbungshierarchie entweder aller Klassen überhaupt, oder aller Klasen eines Packages, angezeigt.
+
Hier wird die komplette Vererbungshierarchie entweder aller Klassen überhaupt, oder aller Klassen eines Packages, angezeigt.
  
 
===Deprecated===
 
===Deprecated===
Zeile 44: Zeile 56:
 
===Help===
 
===Help===
 
Eine Hilfe welche dasselbe erzählt, was auch auf dieser Page steht.
 
Eine Hilfe welche dasselbe erzählt, was auch auf dieser Page steht.
 +
 +
=Wie benutzt man nun die Java API Dokumentation?=
 +
{{In Arbeit}}
 +
 +
=Links=
 +
*[[JavaDoc]]
  
 
[[Kategorie:Java]]
 
[[Kategorie:Java]]
 
[[Kategorie:Java Grundlagen]]
 
[[Kategorie:Java Grundlagen]]

Aktuelle Version vom 14. November 2021, 16:31 Uhr

Das Java Runtime Environment (kurz JRE) bietet viele tausend Klassen, und nochmehr Methoden. Es ist nur schwer möglich, den Überblick über so viele Informationen zu behalten, wenn man nur den Quellcode zur Verfügung hat.

API-Doc Java 9 in a window

Deshalb wurde die "API Dokumentation" geschrieben.

Die API Dokumentation, kurz API-Doc (manchmal auch nur API), kann man bei Oracle herunterladen. Für die aktuelle Java-Version gibt es immer auch eine Onlineversion der Java-API Dokumentation.

Aufbau der API Dokumentation

API-Doc Java 8 in a window

Die API-Doc besteht aus 3 Fenstern:

  • Oben links sind sämtliche Packages aufgeführt
  • Unten links sind die Klassen des aktuell gewählten Packages aufgelistet
  • Rechts ist ein Multifunktionsfenster

Zusätzlich gibt es einige Demonstrationen und Tutorials in der API Dokumentation zu finden.

Das Multifunktionsfenster

Das Fenster auf der rechten Seite der API-Doc hat 8 Funktionen, welche in den Leisten oben und unten ausgewählt werden können. Die Funktionen sind:

Overview

Eine Liste aller verfübgarer Packages. Auf der linken Seite der Tabelle befindet sich der Name des Packages, rechts eine Beschreibung, für was die Klassen des Packages verwendet werden.

Package

Eine Liste aller Elemente welche in einem Package sind. Für jedes Element gibt es eine kurze Beschreibung, wofür es verwendet wird. Elemente können Interfaces, Klassen, Exceptions, Errors, Enumerationen oder Annotations sein.

Class

Diese Ansicht wird verwendet um Elemente eines Packages genauer zu beschreiben. Hauptsächlich sind dies Klassen, aber auch Interfaces, Enumerationen o.ä. wird hier angezeigt.

Diese Ansicht besteht aus 3 Sektionen:

  • Beschreibung: Eine Beschreibung des aktuellen Elementes. Dies beinhaltet die Vererbungshierarchie und einen längeren Text.
  • Zusammenfassung: Eine Liste aller innere Klassen, Variablen, Konstruktoren und Methoden.
  • Details: Für jeden Eintrag in der Zusammenfassung gibt es noch eine detailierte Beschreibung.

Use

Use zeigt an, wo ein Element (Klasse, Interface, Enumeration, etc.) benutzt wird. Sortiert nach Packages wird gezeigt, wer von dem Element erbt, wer das Element als Variable benutzt, wo das Element als Argument oder Rückgabewert einer Methode vorkommt, etc.

Tree

Hier wird die komplette Vererbungshierarchie entweder aller Klassen überhaupt, oder aller Klassen eines Packages, angezeigt.

Deprecated

Eine Liste aller Klassen, Interfaces, Methoden, etc. welche Deprecated (veraltet) sind.

Index

Index ist eine alphabetische Liste aller Elemente welche in der API Dokumentation gefunden werden können.

Help

Eine Hilfe welche dasselbe erzählt, was auch auf dieser Page steht.

Wie benutzt man nun die Java API Dokumentation?

Baustelle.png Dieser Beitrag wird derzeit noch bearbeitet. Der Text ist deshalb unvollständig und kann Fehler oder ungeprüfte Aussagen enthalten.

Links

Abgerufen von „https://wiki.byte-welt.net/mediawiki/index.php?title=API_Dokumentation_(Java)&oldid=9369“