Wizard API-gebruikspatronen

Met deze wizard kunt u patronen voor reguliere expressies maken, waarmee u een analyse voor API-gebruik kunt beheren.

U kunt deze wizard als volgt activeren:

  1. Wanneer u een nieuwe startconfiguratie maakt voor API-gebruiksrapportage, schakelt u over naar de tab Patronen.
  2. Druk op de tab op de knop Toevoegen...

Optie

Beschrijving

Standaardwaarde

Typen patronen In deze lijst worden alle patronen afgebeeld die kunnen worden gemaakt met de wizard. Eerste element in de lijst
Beschrijving Hier wordt de leesbare beschrijving van het soort patroon geselecteerd in de lijst met Typen patronen.  

Op de eerste pagina van de wizard kunt u selecteren welk soort patroon u wilt maken. Beschrijvingen voor elk patroon wordne gegeven om u te helpen kiezen - selecteer het patroon en de beschrijving wordt afgebeeld in het veld Beschrijving.

Wizard API-gebruikspatroon - selectiepagina patroon

Archiefpatronen

Wanneer API-gebruiksanalyse is voltooid, worden alle mappen en archieven binnen een bundel gescand; hiermee wordt ervoor gezorgd dat alle klassebestanden worden geanalyseerd. In sommige gevallen kan een bundel een archief bevatten met oude versies van klassebestanden (bijvoorbeeld) die u niet wilt analyseren. In dit geval kan een archiefpatroon worden gebruikt om een bepaald archief of alle archieven die overeenkomen met een bepaalde reguliere expressie volledig te negeren.

Optie

Beschrijving

Standaardwaarde

Bundelnaam De volledige symbolische naam van de bundel waarop dit patroon moet worden toegepast. Bijvoorbeeld: org.eclipse.pde.api.tools. leeg
Archiefnaam De volledige naam of regulier expressie van het archief/de archieven om het patroon op toe te passen. Bijvoorbeeld: *.jar - Deze negeert alle geneste jar-bestanden. leeg

Wizars API-gebruikspatroon - archiefpatronen maken

Patronen voor pakket

Wanneer verwijzingen worden geëxtraheerd voor analyse, gebruikt de zoekmachine voor API-gebruik metagegevens uit de bundel om te bepalen of een verwijzing intern is of niet. In sommige gevallen is een bundel niet ingesteld om juist te beschrijven welke klassen intern zijn en welke niet. Met een Pakketpatroon kunt u deze fout gevormde bundels verbeteren - alleen met betrekking tot de zoekmachine, de werkelijke bundel wordt niet gewijzigd - om te beschrijven wat wel of niet intern is.

Optie

Beschrijving

Standaardwaarde

Patroon Het patroon van reguliere expressies waarmee pakketten moeten overeenkomen. Bijvoorbeeld: .*\.internal\..*. leeg
API-patroon Of het patroon ervoor moet zorgen dat overeenkomende pakketten worden beschouwd als API of niet. aan

Wizard API-gebruikspatroon - pakketpatronen maken

Rapportconversiepatronen

Wanneer een analyse van API-gebruik is voltooid, kan er een enorme hoeveelheid informatie zijn om in te zoeken. Met een patroon voor rapportconversie kunt u echter minder verwijzingsgegevens afbeelden in de HTML-rapporten, zodat u alleen ziet wat voor u belangrijk is. Als u dit wilt doen, kunt u uitsluitingspatronen maken om de verwijzingen die worden gerapporteerd op te schonen.

Optie

Beschrijving

Standaardwaarde

Verwijzingen filteren naar dit patroon Hiermee kunt u raportverwijzingen naar het patroon negeren. Als het patroon bijvoorbeeld org\.eclipse\.jdt\..* was, zouden met deze optie geen verwijzingen naar JDT worden gerapporteerd. geselecteerd
Verwijzingen filteren vanuit dit patroon Hiermee kunt u raportverwijzingen naar het patroon negeren. Als het patroon bijvoorbeeld org\.eclipse\.jdt\..* was, zouden met deze optie geen verwijzingen vanuit JDT worden gerapporteerd.  
Patroon Het patroon voor reguliere expressies. leeg

Wizard API-gebruikspatroon - conversiepatronen voor rapporten maken

Verwante taken

Setting up API Tools

Verwante onderwerpen

API Tools Setup Action
Menu voor PDE-tools
API-gebruiksrapporten