Guiden API-användningsmönster

Guiden hjälper dig genom stegen att skapa reguljära uttrycksmönster som styr en API-användaranalys.

Så här aktiverar du guiden:

  1. Växla till fliken Mönster när du skapar en ny startkonfiguration för API-användningsrapport.
  2. Klicka på knappen Lägg till på fliken

Alternativ

Beskrivning

Standard

Mönstertyper Listan innehåller alla mönster som kan skapas med guiden. Första elementet i listan
Beskrivning Visar en beskrivning i klartext av den mönstertyp som är markerad i listan Mönstertyper.  

På den första sidan i guiden väljer du vilken typ som mönster som ska skapas. Det finns beskrivningar av alla mönster som hjälper dig att välja - välj helt enkelt mönstret och beskrivningen i fältet Beskrivning.

Guiden API-användningsmönster - sidan för mönsterval

Arkivera mönster

När API-användningsanalysen är klar genomsöks alla mappar och arkiv i paketet för att kontrollera att alla klassfiler har analyserats. I vissa fall kan ett paket innehålla ett arkiv med gamla versioner av klassfiler (till exempel) som du vill ha analyserade. I så fall kan ett arkiverat mönster användas för att helt ignorera ett visst arkiv eller alla arkiv som matchar ett visst reguljärt uttryck.

Alternativ

Beskrivning

Standard

Samlingspaketnamn Det fullständiga symboliska namnet för paketet som mönstret ska tillämpas på. Exempel: org.eclipse.pde.api.tools. tomt
Arkivnamn Det fullständiga namnet på ett reguljärt uttryck för arkiv som mönstret tillämpas på. Exempel: *.jar - ignorerar alla nästlade jar-fil. tomt

Guiden API-användningsmönster - skapar arkivmönster

Paketmönster

När referenser extraheras för analys använder API-sökmotorn metadata från paketet för att bestämma om en referens är intern eller inte. I vissa fall har ett paket inte konfigurerats så att det beskriver vilka klasser som är interna och vilka som inte är det. Med ett paketmönster kan du utöka dessa felaktiga paket - enbart från sökmotorns synvinkel, paketet ändras inte - genom att beskriva vad som är eller inte är internt.

Alternativ

Beskrivning

Standard

Mönster Det reguljära uttrycksmönster som paketet ska matchas mot. Exempel: .*\.internal\..*. tomt
API-mönster Om mönstret ska göra att matchande paket betraktas som APIt eller inte. markerat

Guiden API-användningsmönster - skapar paketmönster

Rapportkonverteringsmönster

När en API-användningsanalys är klar kan det finnas mycket information att gå igenom. Med en rapport över konverteringsmönster kan du dock minska referensinformationen i HTML-rapporter så att endast den information som du är intresserad av visas. I så fall skapar du uteslutningsmönster som rensar de rapporterade referenserna.

Alternativ

Beskrivning

Standard

Filterreferenser till det här mönstret Gör att du kan ignorera rapporterade referenser till mönstret. Exempel: Om mönstret var org\.eclipse\.jdt\..* och du väljer det här alternativet rapporteras inga referenser till JDT. valt
Filterreferenser från det här mönstret Gör att du kan ignorera rapporterade referenser till mönstret. Exempel: Om mönstret var org\.eclipse\.jdt\..* och du väljer det här alternativet rapporteras inga referenser från JDT.  
Mönster Det reguljära uttrycksmönstret. tomt

Guiden API-användningsmönster - skapa rapportkonverteringsmönster

Närliggande uppgifter

Konfigurera API-verktyg

Närliggande referens

Åtgärd för konfiguration av API-verktyg
PDE-verktygsmeny
API-användningsrapporter