Hilfe zu JavaDoc

Navigation

Ausgehend von der Seite Überblick können Sie die Dokumentation mithilfe der Links durchsuchen, die sich auf jeder Seite und in der Navigationsleiste oben auf jeder Seite befinden. Mit Index und dem Suchfeld können Sie zu spezifischen Deklarationen und Übersichtsseiten navigieren, wie Alle Packages, Alle Klassen und Schnittstellen

Seitenarten

Die folgenden Abschnitte beschreiben die verschiedenen Seitenarten in dieser Collection.

Überblick

Die Seite Überblick ist die Titelseite dieses API-Dokuments und enthält eine Liste aller Module mit einer Übersicht für jedes Modul. Diese Seite kann auch eine Gesamtbeschreibung des Modulsets enthalten.

Modul

Für jedes Modul ist eine Seite vorhanden, die eine Liste der Packages, Abhängigkeiten von anderen Modulen und Services mit jeweils einer Übersicht dafür enthält. Diese Seiten können die folgenden Kategorien enthalten:

  • Packages
  • Module
  • Services

Package

Für jedes Package ist eine Seite vorhanden, die eine Liste der Klassen und Schnittstellen mit jeweils einer Übersicht dafür enthält. Diese Seiten können die folgenden Kategorien enthalten:

  • Schnittstellen
  • Klassen
  • Enum-Klassen
  • Ausnahmeklassen
  • Annotationsschnittstellen

Klasse oder Schnittstelle

Für jede Klasse, Schnittstelle, verschachtelte Klasse und verschachtelte Schnittstelle ist eine separate Seite vorhanden. Jede dieser Seiten enthält drei Abschnitte, die aus einer Deklaration und Beschreibung, Mitgliederübersichtstabellen und detaillierten Mitgliederbeschreibungen bestehen. Die Einträge in diesen Abschnitten werden weggelassen, wenn sie leer oder nicht anwendbar sind.

  • Klassenvererbungsdiagramm
  • Direkte Unterklassen
  • Alle bekannten Unterschnittstellen
  • Alle bekannten Implementierungsklassen
  • Klassen- oder Schnittstellendeklaration
  • Klassen- oder Schnittstellenbeschreibung

  • Verschachtelte Klassen - Übersicht
  • Enum-Konstanten - Übersicht
  • Feldübersicht
  • Eigenschaftsübersicht
  • Konstruktorübersicht
  • Methodenübersicht
  • Erforderliche Elemente - Übersicht
  • Optionale Elemente - Übersicht

  • Enum-Konstanten - Details
  • Felddetails
  • Eigenschaftsdetails
  • Konstruktordetails
  • Methodendetails
  • Elementdetails

Hinweis: Annotationsschnittstellen haben erforderliche und optionale Elemente, aber nicht Methoden. Nur Enum-Klassen haben Enum-Konstanten. Die Komponenten einer Datensatzklasse werden als Teil der Deklaration der Datensatzklasse angezeigt. Eigenschaften sind ein Feature von JavaFX.

Die Übersichtseinträge sind alphabetisch geordnet, während die detaillierten Beschreibungen in der Reihenfolge aufgeführt werden, in der sie im Quellcode auftreten. So werden die vom Programmierer festgelegten logischen Gruppierungen beibehalten.

Weitere Dateien

Packages und Module können Seiten mit weiteren Informationen zu den Deklarationen in der Nähe enthalten.

Verwendung

Für jedes dokumentierte Package sowie jede Klasse und jede Schnittstelle ist eine eigene Verwendungsseite vorhanden. Auf dieser Seite wird beschrieben, welche Packages, Klassen, Methoden, Konstruktoren und Felder einen Teil der angegebenen Klasse oder des angegebenen Packages verwenden. Bei der Klasse oder Schnittstelle A enthält die Verwendungsseite die Unterklassen von A, als A deklarierte Felder, Methoden, die A zurückgeben, sowie Methoden und Konstruktoren mit Parametern des Typs A. Sie können diese Seite aufrufen, indem Sie zunächst das Package, die Klasse oder die Schnittstelle aufrufen und anschließend in der Navigationsleiste auf den Link "Verwendung" klicken.

Baum (Klassenhierarchie)

Es gibt eine Seite Klassenhierarchie für alle Packages, und für jedes Package gibt es eine Hierarchie. Jede Hierarchieseite enthält eine Klassen- und eine Schnittstellenliste. Die Klassen sind nach Vererbungsstruktur organisiert, beginnend mit java.lang.Object. Die Schnittstellen erben nicht von java.lang.Object.

  • Wenn Sie auf der Übersichtsseite auf "Baum" klicken, wird die Hierarchie für alle Packages angezeigt.
  • Wenn Sie eine bestimmte Package-, Klassen- oder Schnittstellenseite anzeigen und auf "Baum" klicken, wird die Hierarchie nur für dieses Package angezeigt.

Veraltete API

Auf der Seite Veraltete API werden alle APIs aufgeführt, die veraltet sind. Die Verwendung einer veralteten API ist nicht empfehlenswert, im Allgemeinen aufgrund von Mängeln. In der Regel wird eine Ersatz-API angegeben. Veraltete APIs werden in künftigen Implementierungen möglicherweise entfernt.

Konstantenfeldwerte

Auf der Seite Konstantenfeldwerte sind die statischen endgültigen Felder und deren Werte aufgeführt.

Serialisierte Form

Jede serialisierbare oder externalisierbare Klasse verfügt über eine Beschreibung der zugehörigen Serialisierungsfelder und -methoden. Diese Informationen sind eher für Implementierer als für Benutzer der API von Interesse. Die Navigationsleiste enthält zwar keinen Link, Sie können diese Informationen jedoch abrufen, indem Sie zu einer beliebigen serialisierten Klasse navigieren und im Abschnitt "Siehe auch" der Klassenbeschreibung auf "Serialisierte Form" klicken.

Alle Packages

Die Seite Alle Packages enthält einen alphabetischen Index aller Packages, die in der Dokumentation enthalten sind.

Alle Klassen und Schnittstellen

Die Seite Alle Klassen und Schnittstellen enthält einen alphabetischen Index aller Klassen und Schnittstellen in der Dokumentation, einschließlich Annotationsschnittstellen, Enum-Klassen und Datensatzklassen.

Index

Die Index enthält einen alphabetischen Index aller Klassen, Schnittstellen, Konstruktoren, Methoden und Felder in der Dokumentation sowie Übersichtsseiten wie Alle Packages, Alle Klassen und Schnittstellen.

Diese Hilfedatei gilt für die vom Standard-Doclet generierte API-Dokumentation.