API-Verwendungsberichte

Ein API-Verwendungsbericht beschreibt eine Reihe von Verweisen von einer Gruppe von Produktpaketen auf eine andere Gruppe von Produktpaketen. Ein Bericht kann mithilfe der Ant-Task für API-Verwendung generiert werden. Eine Benutzerschnittstelle wird bereitgestellt, um einen Bericht im Dialog Externe Tools zu konfigurieren und zu generieren. Um eine neue Konfiguration für einen Verwendungssuchlauf zu erstellen, doppelklicken Sie einfach auf den Konfigurationstyp API-Verwendungsbericht.

Registerkarte 'API-Verwendungsbericht'

Auf der Registerkarte API-Verwendungsbericht können Sie die Analyse konfigurieren.

Das folgende Beispiel zeigt eine Konfiguration zum Extrahieren aller Verweise auf Eclipse-Produktpakete in einer 3.4-Installation.

Registerkarte 'API-Verwendungsbericht'


Option

Beschreibung

Standardwert

Analysieren Sie können auswählen, was analysiert werden soll. Dies kann entweder eine API-Referenzkonfiguration, eine Zieldefinition oder ein Verzeichnis mit Produktpaketen sein. Sie können auch auswählen, dass nur HTML für einen vorhandenen Bericht generiert werden soll. Es kann jeweils nur eine Option ausgewählt werden, wobei jede Option konfigurierbar ist. Das heißt, Sie können zur Benutzervorgabenseite der API-Referenzkonfigurationen wechseln, um bestehende Referenzkonfigurationen zu bearbeiten, wenn Sie ausgewählt haben, dass eine API-Referenzkonfiguration analysiert werden soll. API-Referenzkonfiguration
Analysieren > API-Referenzkonfiguration Sie können aus dem Kombinationsfeld eine beliebige API-Referenzkonfiguration auswählen, die analysiert werden soll. Standardreferenzkonfiguration oder leer
Analysieren > Referenzkonfigurationen... Ermöglicht den Zugriff auf die Benutzervorgabenseite API-Referenzkonfigurationen, um die zu analysierende Referenzkonfiguration zu konfigurieren.  
Analysieren > Zieldefinition Sie können aus dem Kombinationsfeld eine beliebige Zieldefinition auswählen, die analysiert werden soll. Aktive Zieldefinition oder leer
Analysieren > Ziele Ermöglicht den Zugriff auf die Benutzervorgabenseite Zielplattform, um die zu analysierende Zieldefinition zu konfigurieren.  
Analysieren > Verzeichnis Sie können den absoluten Pfad zu einem Verzeichnis mit den Produktpaketen eingeben. Leer
Analysieren > Durchsuchen... Ermöglicht Ihnen das Suchen nach einem Ordner mit Produktpaketen, der analysiert werden soll.  
Analysieren > HTML-Bericht für vorhandenen Verwendungssuchlauf generieren Ermöglicht Ihnen das Erstellen eines Berichts für einen vorhandenen Suchlauf, ohne die Analyse erneut ausführen zu müssen.  
Suchen nach > Verweise auf Ermöglicht Ihnen das Angeben des Namens (oder des entsprechenden regulären Ausdrucks) des Produktpakets, für das Sie die Verweise sehen wollen. Ein Beispiel: org\.eclipse.*. In diesem Beispiel sollen alle Verweise auf sämtliche Produktpakete angezeigt werden, deren Name mit org.eclipse. beginnt. Leer
Suche nach > API-Verweise Ermöglicht Ihnen das Suchen nach API-Verweisen. Nicht markiert
Suche nach > Interne Verweise Ermöglicht Ihnen das Suchen nach internen Verweisen. Markiert
Suche nach > Unzulässige API-Verwendung Ermöglicht Ihnen das Suchen nach Fällen von unzulässiger API-Verwendung, d. h. der Verwendung eingeschränkter API-Member. Nicht markiert
Suche in > Übereinstimmende Produktpakete Ermöglicht Ihnen das Angeben des Namens (oder des entsprechenden regulären Ausdrucks) des Produktpakets bzw. der Produktpakete, das/die Sie auf abgehende Verweise durchsuchen wollen, d. h. Sie können hier einen Suchbereich angeben. Ein Beispiel: .*. In diesem Beispiel sollen alle Produktpakete durchsucht werden, deren Namen mit einer beliebigen Zeichenfolge übereinstimmen. Um denselben Effekt zu erzielen, kann das Feld auch leer gelassen werden. Leer
Berichtsgenerierung > Berichtstyp Ermöglicht die Auswahl zwischen zwei HTML-Berichtsformaten. Wenn Bericht für referenzierte Pakete (Erzeuger) ausgewählt wird, listet der Bericht alle Produktpakete auf, die Typen enthalten, auf die in den durchsuchten Produktpaketen verwiesen wird. Wenn Bericht für verweisende Pakete (Verbraucher) ausgewählt wird, wird der Bericht so angelegt, dass er alle Produktpakete im Suchbereich zeigt, die Verweise enthalten.

Wenn Sie den Berichtstyp wechseln, überprüfen Sie, ob die regulären Ausdrücke für Verweise auf und Übereinstimmende Pakete die richtigen Werte enthalten. Wenn in einer Einstellung ein Platzhalterausdruck wie '.*' verwendet wird, erfordert ein Wechsel zu einem anderen Berichtstyp häufig ein Versetzen des Platzhalterausdrucks in die andere Einstellung, um den nützlichsten Bericht zu erhalten.

Bericht für referenzierte Pakete (Erzeuger)
Berichtsgenerierung > Berichtsausgabeposition Ermöglicht Ihnen das Angeben des absoluten Pfads, in den alle generierten Berichte gestellt werden sollen. Leer
Berichtsgenerierung > Durchsuchen... Ermöglicht Ihnen das Auswählen der Position für die Ausgabe aller Berichte.  
Berichtsgenerierung > Berichtsverzeichnis vor Erstellen neuer Ergebnisberichte bereinigen Ermöglicht Ihnen das Bereinigen einer vorhandenen XML-Berichtsposition, bevor die Suche irgendwelche Ergebnisse meldet. Hierbei ist zu beachtend, dass mit dieser Option das angegebene Berichtsverzeichnis (sofern vorhanden) vollständig entfernt wird, wobei auch alle untergeordneten Verzeichnisse rekursiv entfernt werden. Nicht markiert
Berichtsgenerierung > HTML-Berichte erstellen Konvertiert die gesamte XML-Ausgabe in formatierte HTML-Dateien, die in das Verzeichnis <berichtsposition>\html gestellt werden. Nicht markiert
Berichtsgenerierung> HTML-Berichtsposition bereinigen Ermöglicht Ihnen das Bereinigen einer vorhandenen HTML-Position vor dem Erstellen neuer Berichte. Hierbei ist zu beachten, dass mit dieser Option das angegebene HTML-Verzeichnis (sofern vorhanden) vollständig entfernt wird, wobei auch alle untergeordneten Verzeichnisse rekursiv entfernt werden. Diese Option wird nur dann aktiviert, wenn Sie die vorstehend genannte Option HTML-Berichte erstellen auswählen. Nicht markiert
Berichtsgenerierung > Bericht nach Abschluss der Suche öffnen Öffnet den HTML-Bericht, wenn die Analyse abgeschlossen ist. Diese Option wird nur dann aktiviert, wenn Sie die vorstehend genannte Option HTML-Berichte erstellen auswählen. Nicht markiert
Berichtserstellung > Beschreibung Ermöglicht Ihnen, eine vom Benutzer lesbare Beschreibung für den Bericht einzugeben. Leer

Registerkarte 'Muster'

Auf der Registerkarte Muster können Sie eine Reihe von Mustern für reguläre Ausdrücke erstellen, um die Verwendungsanalyse zu steuern. Derzeit werden drei Arten von Mustern unterstützt:

  1. Archivmuster - Ermöglicht das Angeben von verschachtelten Archiven, die während der Analyse ignoriert werden sollen.
  2. Paketmuster - Ermöglicht das Angeben von Paketen (es sollten API- oder interne Pakete sein), ohne das Produktpaketmanifest aktualisieren zu müssen.
  3. Berichtskonvertierungsmuster - Ermöglicht das Erstellen eines regulären Ausdrucks für Paketnamen zum Filtern gemeldeter Verweise. Alle gemeldeten Verweise werden anhand ihres vollständig qualifizierten Paketnamens gefiltert.

Registerkarte 'Muster'


Option

Beschreibung

Standardwert

Hinzufügen... Ermöglicht Ihnen das Hinzufügen eines neuen Musters. Mit dieser Schaltfläche wird der Assistent 'Muster' gestartet.  
Bearbeiten Ermöglicht Ihnen das Bearbeiten des momentan ausgewählten Musters. Es kann jeweils immer nur ein Muster zur Zeit bearbeit werden.  
Entfernen Ermöglicht Ihnen das Entfernen des ausgewählten Musters. Es können auch mehrere Muster gleichzeitig entfernt werden.  

Zugehörige Tasks

Mit API-Referenzkonfiguration vergleichen
Referenzkonfiguration einrichten

Zugehörige Referenzinformationen

Benutzervorgaben 'API-Referenzkonfiguration'
Assistent 'API-Verwendungsmuster'