Rapporter over API-brug

En Rapport over API-brug beskriver et sæt referencer fra ét sæt bundter til et andet sæt bundter. En rapport kan genereres vha. Ant-opgave: API-brug. Der leveres en brugergrænseflade, som konfigurerer og genererer en rapport i dialogboksen Eksterne værktøjer. Hvis du vil oprette en ny brugsscanning, skal du bare dobbeltklikke på konfigurationstypen Rapport over API-brug.

Skillebladet Rapport over API-brug

På skillebladet Rapport over API-brug kan du konfigurere analysen.

Følgende eksempel viser en konfiguration, der udtrækker alle referencer til Eclipse-bundter i en 3.4-installation.

Skillebladet Rapport over API-brug


Indstilling

Beskrivelse

Standard

Analysér Du kan vælge, hvad du vil analysere. Det kan enten være en API-grundlinje, en måldefinition eller et bibliotek med bundter. Du kan også vælge at nøjes med at generere HTML for en eksisterende rapport. Du kan nøjes med at vælge én indstilling, og du kan konfigurere hver indstilling enkeltvis. Det vil sige, at du kan gå til indstillingssiden API-grundlinje for at redigere eksisterende grundlinjer, hvis du vælger at analyse en API-grundlinje. API-grundlinje
Analysér > API-grundlinje Du kan analysere en hvilken som helst af API-grundlinjerne i kombinationsboksen. Standardgrundlinje eller tom
Analysér > Grundlinjer... Giver adgang til indstillingssiden API-grundlinjer, hvor du kan konfigurere den grundlinje, du vil analysere.  
Analysér > Måldefinition Du kan analysere en hvilken som helst af måldefinitionerne i kombinationsboksen. Den aktive måldefinition eller tom
Analysér > Mål Giver adgang til indstillingssiden Målplatform, hvor du kan konfigurere den måldefinition, du vil analysere.  
Analysér > Bibliotek Du kan angive den absolutte sti til et bibliotek, der indeholder bundterne. tom
Analysér > Gennemse... Giver mulighed for at søge efter en folder med bundter, der skal analyseres.  
Analysér > Generér HTML-rapport for eksisterende brugsscanning Giver mulighed for at oprette en rapport for en eksisterende scanning uden at skulle udføre analysen igen.  
Søg efter > Referencer til Giver mulighed for at angive navnet (eller den matchende RegEx) for det bundt, du vil se referencer til. Se f.eks. følgende eksempel: org\.eclipse.*. I dette eksempel siger vi, at vi vil se alle referencer til et hvilket som helst bundt, der starter med navnet org.eclipse.. tom
Søg efter > API-referencer Giver mulighed for at scanne efter API-referencer. ikke markeret
Søg efter > Interne referencer Giver mulighed for at scanne efter interne referencer. markeret
Søg efter > Ugyldig API-brug Giver mulighed for at scanne efter ugyldig API-anvendelse, dvs. brug af begrænsede API-medlemmer. ikke markeret
Søg i > Bundtmatch Giver mulighed for at angive navnet (eller den matchende RegEx) for det eller de bundter, du vil scanne efter referencer fra, dvs. et søgeomfang. Se følgende eksempel: .*. I dette eksempel siger vi, at vi vil søge i alle bundter, hvis navne matcher enhver tegnsekvens. Samme effekt kan opnås ved at lade feltet være tomt. tom
Rapportering > Rapporttype Giver mulighed for at vælge mellem to HTML-rapportformater. Hvis der er valgt Rapport over bundter, der er refereret til (producenter), viser rapporten alle bundter, der de typer, som der refereres til i de søgte bundter. Hvis der er valgt Rapport over refererende bundter (forbrugere), organiseres rapporten, så den viser alle bundterne i søgeomfanget, som indeholder referencer.

Når du skifter rapporttype, skal du kontrollere, at de regulære udtryk Referencer til og Bundter, der matcher har de korrekte værdier. Ved skift af rapporttype skal jokertegnet ofte flyttes til den anden indstilling for at opnå den bedste rapport, når du bruger et jokertegnudtryk som f.eks. .* i den ene indstilling.

Rapport over bundter, der er refereret til (producenter)
Rapportering > Outputplacering for rapport Giver mulighed for at angive den absolutte sti, hvor genererede rapporter skal placeres. tom
Rapportering > Gennemse... Giver mulighed for at vælge outputplacering for rapporter.  
Rapportering > Ryd op i rapportbibliotek før rapportering af nye resultater Giver mulighed for at rydde op i en eksisterende placering af en HTML-rapporter, inden scanningen rapporterer nogen resultater. Bemærk, at denne indstilling fuldstændigt fjerner det angivne rapportbibliotek, hvis det findes, og at alle underordnede biblioteker ogs fjernes rekursivt. ikke markeret
Rapportering > Opret HTML-rapporter Konverterer alt XML-output til formateret HTML og placerer det i <rapportplacering>\html ikke markeret
Rapportering > Ryd op i HTML-rapportplacering Giver mulighed for at rydde op i en eksisterende HTML-placering, inden der oprettes nye rapporter. Bemærk, at denne indstilling fuldstændigt fjerner det angivne HTML-bibliotek, hvis det findes, og at alle underordnede biblioteker ogs fjernes rekursivt. Indstillingen er kun aktiveret, hvis du vælger indstillingen Opret HTML-rapporter, der nævnes ovenfor. ikke markeret
Rapportering > Åbn rapport, når søgningen er færdig Åbner HTML-rapporten, når analysen er udført. Indstillingen er kun aktiveret, hvis du vælger indstillingen Opret HTML-rapporter, der nævnes ovenfor. ikke markeret
Rapportering > Beskrivelse Giver mulighed for at angive en beskrivelse af rapporten i klar tekst. tom

Skillebladet Mønstre

På skillebladet Mønstre kan du oprette en lang række mønstre af typen regulært udtryk for at styre brugsanalysen. I øjeblikket understøttes tre typer mønstre:

  1. Arkivmønster - Giver mulighed for at angive indlejrede arkiver, der skal ignoreres under analysen.
  2. Pakkemønster - Giver mulighed for at angive pakker, der skal være API eller interne, uden at skulle opdatere bundtmanifestet.
  3. Mønster for rapportkonvertering - Giver mulighed for at oprette et pakkenavnemønster, så du kan filtrere de referencer, der rapporteres. Alle rapporterede referencer filtreres baseret på deres fuldstændige pakkenavn.

Skillebladet Mønstre


Indstilling

Beskrivelse

Standard

Tilføj... Giver mulighed for at tilføje et nyt mønster. Knappen starter guiden Mønster.  
Redigér Giver mulighed for at redigere det aktuelt valgte mønster. Du kan kun redigere ét mønster ad gangen.  
Fjern Giver mulighed for at fjerne det eller de valgte mønstre. Du kan fjerne mere end ét mønster ad gangen.  

Relaterede opgaver

Sammenligning med en API-grundlinje
Konfigurér en grundlinje

Relaterede referencer

API-grundlinjeindstillinger
Guiden API-brugsmønstre