Java: Bruk forhåndsdefinerte notater - dummies

Typene og innholdet i annoteringer i Java, som kommentarer, er begrenset bare av fantasien din. Ja, Java gir noen forhåndsdefinerte merknader, men du kan også lage notater som beskriver programelementer på en hvilken som helst måte du vil. Tanken er at du beskriver hvordan en annotasjon skal fungere, gi data for det, og kompilatoren tar vare på resten.

Merknader begynner alltid med @ (at) symbolet. Så når du ser @Documented, vet du at du ser en kommentar. De følgende avsnittene forteller deg mer om forhåndsdefinerte og tilpassede merknader.

En forhåndsdefinert annotasjon er en som eksisterer som en del av Java. Du finner disse merknadene i java. Lang. annotasjonspakke. For å bruke dem, legger du til import java. Lang. merknad. *; til begynnelsen av søknaden din. Følgende liste gir en oversikt over de forhåndsdefinerte annotasjonene:

• @Deprecated: Noen ganger et element - en klasse, metode, felt eller annen programmeringsfunksjon - erstattes av et nyere element eller er ikke lenger lenger behov for.

  Når dette skjer, markerer du elementet som utdatert slik at utviklere vet at de trenger å oppdatere koden og slutte å bruke det aktuelle elementet. Hvis du legger til @Deprecated annotering, blir den utdaterte statusen til elementet i dokumentasjonen generert av Javadoc (et verktøy som brukes til å lage dokumentasjon automatisk basert på innholdet i kodefilene dine).

• @Documented: Når du merker et element som dokumentert, sender Javadoc-verktøyet den til dokumentasjonsfilen den lager basert på kildefilinnholdet.

• @FunctionalInterface: Angir at grensesnittet er et funksjonelt grensesnitt som brukes for anonyme klasser og lambda-uttrykk.

• @Inherited : Klasser kan arve egenskaper fra en foreldersklasse. Som standard inkluderer dette funksjonalitet, for eksempel metoder, men inkluderer ikke forklassens annoteringer. Ved hjelp av @Inherited-kommentaren, forteller Java at de også bruker underklasseklasseannonseringene til underkategorien.

• @Override: Angir at et barn klasse element overstyrer et superklasse (foreldre klasse) element. Hvis denne annotasjonen er til stede og superklassen mangler et element med samme navn, utgiver kompilatoren en feil, slik at du vet at noe er galt med overstyringen.

• @Repeatable: De fleste annotasjoner blir bare brukt én gang til et bestemt element. I noen tilfeller må du imidlertid bruke annotasjonen mer enn en gang. Denne annotasjonen forteller Java at det er akseptabelt å bruke annoteringen til et bestemt element mer enn en gang.

• @Retention: En annotasjon kan bare påvirke kildekoden; kildekoden og kompilatoren; eller kildekoden, kompilatoren og JVM. Denne annotasjonen definerer hvilken effekt en annen kommentar skal ha. For eksempel kan det hende du trenger bare en dokumentasjonsspesifikk merknad for å påvirke kildekoden og kompilatoren.

• @SafeVarargs: Det er mulig å utføre operasjoner som ikke er sikre på argumentene som overføres til en metode eller konstruktør. Denne merknaden sier at koden ikke gjør noe usikkert og derfor ikke krever alle vanlige kontroller. Redusering av antall sjekker gjør at programmet kjører raskere.

• @SuppressWarnings: Java-kompilatoren gir et vell av advarsler for å signalisere potensielle problemer. Hvis du for eksempel prøver å bruke en utdatert metode i koden din, sender kompilatoren en advarsel om det. Denne merknaden forteller at kompilatoren ikke sender ut slike advarsler for det berørte elementet.

• @ Target: Når du lager egne kommentarer, kan det være nyttig å fortelle kompilatoren at disse merknadene bare skal påvirke en bestemt elementtype. Hvis du for eksempel lager en forfatterblokk som bare skal vises på pakkenivå, kan du begrense annotasjonen til bare den elementstypen ved å bruke @Target-annotasjonen.