Der Assistent
Javadoc-Generierung ermöglicht das Generieren von Javadoc-Dateien. Er stellt eine Schnittstelle für das Tool javadoc.exe dar, das in der Java-JDK verfügbar ist. Auf der Seite Sun's Javadoc Tool finden Sie eine vollständige Dokumentation für das Javadoc-Tool.
Typauswahl:
Option |
Beschreibung |
---|---|
Typen auswählen, für die eine Javadoc-Generierung erfolgt |
Aktivieren bzw. inaktivieren Sie die Markierungsfelder in der Liste, um exakt die Typen anzugeben, die in die JAR-Datei exportiert werden sollen. Diese Liste wird mit der Workbench-Auswahl initialisiert. Nur ein Projekt kann jeweils ausgewählt werden, da jeweils nur der Klassenpfad eines Projekts verwendet werden kann, während das Javadoc-Tool ausgeführt wird. |
Javadoc für sichtbare Member erstellen |
|
Standard-Doclet verwenden |
Javadoc-Befehl mit dem Standard-Doclet starten (Standardeinstellung)
|
Angepasstes Doclet verwenden |
Verwendung eines angepassten Doclets zur Generierung von Dokumentation
|
Standard-Doclet-Argumente (bei Auswahl von Standard-Doclet verwenden verfügbar):
Option |
Beschreibung |
---|---|
Dokumenttitel |
Angeben eines Dokumenttitels. |
Verwendungsseite generieren | Wählen Sie diese Option aus, wenn die Dokumentation eine Verwendungsseite enthalten soll. |
Hierarchiebaumstruktur generieren | Wählen Sie diese Option aus, wenn die Dokumentation eine Baumstrukturseite enthalten soll. |
Navigatorleiste generieren |
Wählen Sie diese Option aus, wenn die Dokumentation eine Navigatorleiste (Kopfzeile und Fußzeile) enthalten soll. |
Index generieren | Wählen Sie diese Option aus, wenn die Dokumentation eine Indexseite enthalten soll. |
Index nach Buchstaben generieren | Für jeden Buchstaben einen Indexeintrag generieren. Diese Option ist aktiviert, wenn Index generieren ausgewählt ist. |
@author | Wählen Sie diese Option aus, wenn das Tag '@author' dokumentiert werden soll. |
@version | Wählen Sie diese Option aus, wenn das Tag '@version' dokumentiert werden soll. |
@deprecated | Wählen Sie diese Option aus, wenn das Tag '@deprecated' dokumentiert werden soll. |
heruntergestufte Liste | Wählen Sie diese Option aus, wenn die Dokumentation eine Seite 'Heruntergestuft' enthalten soll. Diese Option ist aktiviert, wenn die Option @deprecated ausgewählt wird. |
Klassen mit Verweisen auswählen, zu denen Javadoc Links erstellen soll |
Geben Sie an, zu welcher anderen Dokumentation Javadoc Links erstellen soll, wenn auf andere Typen verwiesen wird.
|
Style-Sheet | Zu verwendendes Style-Sheet auswählen |
Allgemeine Javadoc-Optionen:
Option |
Beschreibung |
---|---|
Übersicht |
Gibt an, dass Javadoc den Text für die Dokumentation der Übersicht aus der angegebenen Datei abrufen sollte. Dieser Text wird in der Datei overview-summary.html platziert. |
Zusätzliche Javadoc-Optionen |
Fügen Sie hier eine beliebige Anzahl zusätzlicher Optionen hinzu: angepasste Doclet-Optionen, VM-Optionen oder JRE 1.4-Kompatibilitätsoptionen. |
Einstellungen dieses Javadoc-Exports als Ant-Script speichern |
Speichern eines Ant-Scripts angeben, das den angegebenen Javadoc-Export ohne Benötigung des Assistenten ausführt. Vorhandenes Ant-Script kann mit diesem Assistenten bearbeitet werden. (Verwenden Sie hierfür die Option für das Öffnen des Javadoc-Assistenten im Kontextmenü des generierten Ant-Scripts.) |
Generierte Indexdatei in Browser öffnen | Öffnet die generierte Datei index.html im Browser (nur bei Verwendung des Standard-Doclets verfügbar). |
Klicken Sie auf Fertig stellen, um die Javadoc-Generierung zu starten. Unterscheidet sich das Ziel von der Position, die auf der Seite Javadoc-Position des Projekts konfiguriert wurde, werden Sie gefragt, ob Sie die Javadoc-Position des Projekts als neuen Zielordner festlegen möchten. Tun Sie dies, verwenden alle Aufrufe für 'Externe Javadoc öffnen# die soeben erstellte Dokumentation.
Eine neue Verarbeitung wird gestartet, und die Generierung wird im Hintergrund ausgeführt. Öffnen Sie die Sicht Konsole (Fenster > Sicht anzeigen > Konsole), um den Fortschritt und den Status der Generierung anzuzeigen.
Javadoc-Dokumentation erstellen