Innledning Merknader i Java
Merknader ble introdusert eller ble tilgjengelige i 1.5-versjonen av Java Development Kit (JDK). Merknader i Java gir mer informasjon om dataene som er til stede i kodestrukturen, dvs. det er data om data også kjent som metadata.
Hva er merknader i Java?
Merknader hjelper til med å definere metadata i kode på en standardisert måte. Merknader hjelper også med å gi instruksjoner til din Java-kompilator å følge mens du sammenstiller den java-koden.
Når vi bruker merknadene, bruker vi '@' -tegnet og deretter etterfulgt av navnet på merknaden din, slik at kompilatoren behandler det som en merknad. Det er viktig å merke seg at merknadene kan legges til før-
- En klassedeklarasjon
- En medlemsvariabel erklæring
- En konstruktørerklæring
- En metodedeklarasjon
- En parametererklæring
- En lokal variabel erklæring.
Viktige punkter å huske er at alle merknader utvider java.lang.annotation.Annotation interface. Merknader kan heller ikke inkludere utvidelsesklausul.
Innebygde Java-merknader
I Java er det innebygde merknader som @Override, @Deprecated, @SuppressWarnings som er designet for et bestemt formål og brukes i en av de ovennevnte situasjonene, for eksempel bare for klassen eller bare for metode, etc.
Eksempel 1 - Override
class Dad (
public void say() (
System.out.println("Do your homework");
)
)
public class Child extends Dad (
@Override
public void say()(
System.out.println("I wanna play");
)
public static void main(String args())(
Dad daddy = new Child();
daddy.say();
)
)
Produksjon
Eksempel # -Utregnet
public class Outdated
(
@Deprecated
public void oldShow()
(
System.out.println("This Method is deprecated"); )
public static void main(String args())
(
Outdated od = new Outdated ();
od.oldShow();
)
)
Produksjon
Meta-merknader
Det er fem typer meta-merknader:
- Dokumentert - Den informerer om at medlemmet eller variabelen eller klassen som bruker denne merknaden, må dokumenteres av Javadoc eller andre lignende tilgjengelige verktøy.
- Mål - Den brukes til å spesifisere hvilken type merknaden som skal brukes. Det brukes mest sammen med dine tilpassede merknader.
- Arvet - Det markerer merknaden som skal arves til underklassen.
- Oppbevaring - Det indikerer hvor lange merknader med den merkede typen som skal beholdes. Det tar argumentet for oppbevaringspolitikk hvis mulige verdier er: KILDE, KLASSE og RUNTIME.
- Gjentas - Dette informerer om at merknadstypene hvis erklæring den kommenterer er repeterbare.
Eksempel - Dokumentasjon og oppbevaring
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@interface RSample (
String rentent();
)
@Documented
@interface DSample (
String doc();
)
public class MetaAnnotate (
public static void main(String arg())
(
new MetaAnnotate().rentent();
new MetaAnnotate().doc();
)
@RSample (rentent="Meta Info R")
public void rentent() (
System.out.println("Retention Policy Applied");
)
@DSample(doc="Meta Info D")
public void doc() (
System.out.println("Code Documented with the value");
)
)
Produksjon
Forklaring
RetentionPolicy.RUNTIME - Denne verdien spesifiserer at merknadsverdien skal være tilgjengelig ved kjøretid, for inspeksjon via java-refleksjon.
Kjør Javadoc-kommandoen for å se dokumentasjonen til koden din.
Typer merknader
Det er tre kategorier av merknader, og det er som følger:
1. Merkermerknader - Disse typene merknader brukes som en erklæring for å varsle utvikleren hva funksjonen eller klassen nedenfor handler om, dvs. at den deler ekstra informasjon om funksjonen eller klassen som om funksjonen overstyrer en annen funksjon eller er funksjonen utdatert, etc. @Override, @ Verdsatt anses som merkemerker.
Eksempel: DemoAnnotation ()
2. Merknader med en verdi - Denne typen merknader tar verdi for å spesifisere den verdien for det medlemmet som merknaden er plassert foran, og trenger derfor ikke å spesifisere navnet på det medlemmet.
Eksempel: DemoAnnotation (“custId123”)
3. Full kommentarer - Denne typen kommentarer tar inn flere verdier, par, medlemmer.
Eksempel: DemoAnnotation (kategori = ”Leker”, verdi = 1500)
Tilpasset
Tilpassede merknader opprettes av brukergrensesnittet, etterfulgt av et merknadsnavn som vi vil se i eksemplet nedenfor.
Fil 1: Definert tilpasset merknad
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target((ElementType.TYPE, ElementType.METHOD))
@Retention(RetentionPolicy.RUNTIME)
@interface Magicians
(
String Wizard() default "Reynolds";
String House() default "Green";
)
@Magicians
public class Magician
(
@Magicians(Wizard = "Harry Potter", House = "Red")
public String getString() ( return null; )
)
Fil 2: Hovedklasse som kaller tilpasset merknadsklasse
import java.lang.annotation.Annotation;
import java.lang.reflect.AnnotatedElement;
import java.lang.reflect.Method;
public class MyCustomAnnotation
(
public static void main(String() args) throws NoSuchMethodException, SecurityException
(
new Magician();
Class magic = Magician.class;
readAnnotationOn(magic);
Method method = magic.getMethod("getString", new Class()());
readAnnotationOn(method);
)
static void readAnnotationOn(AnnotatedElement element)
(
try
(
System.out.println("\n Find annotations on " + element.getClass().getName());
Annotation() annotations = element.getAnnotations();
for (Annotation annotation : annotations)
(
if (annotation instanceof Magicians)
(
Magicians mData = (Magicians) annotation;
System.out.println("Wizard Name :" + mData.Wizard());
System.out.println("Wizard House Color :" + mData.House());
)
)
) catch (Exception e)
(
e.printStackTrace();
)
)
)
Produksjon
Konklusjon
I denne artikkelen lærte vi om hva som er java-merknader og deres typer med eksempler, sammen så vi eksempler på innebygde merknader levert av java og kodet de tilpassede merknadene våre.
Vi lærte at merknader er nyttige ved standardisering av koden og hjelper også til bedre å forstå koden og dens struktur.
Anbefalte artikler
Dette er en guide til Java-merknader. Her diskuterer vi Hvordan bygge innebygde Java-merknader med de gitte eksempler og utganger. Du kan også se på følgende artikler for å lære mer -
- Variabler i Java
- Mønstre i Java
- Rask sortering i Java
- Beste Java-kompilatorer
- instans av i Java med eksempel