Introduktionsanteckningar i Java
Kommentarer introducerades eller blev tillgängliga i 1.5-versionen av Java Development Kit (JDK). Annoteringar i Java ger mer information om de data som finns i kodstrukturen, dvs det är data om data som också kallas metadata.
Vad är kommentarer i Java?
Anteckningar hjälper till att definiera metadata i kod på ett standardiserat sätt. Kommentarer hjälper också till att ge instruktioner till din java-kompilator att följa när du sammanställer den java-koden.
När vi använder kommentarerna använder vi "@" -tecknet och följs sedan av namnet på din kommentar, så att kompilatorn behandlar det som en kommentar. Det är viktigt att notera att anteckningarna kan läggas till innan-
- En klassdeklaration
- En medlemsvariabel förklaring
- En konstruktörsdeklaration
- En metoddeklaration
- En parameterdeklaration
- En lokal variabeldeklaration.
Viktiga punkter att komma ihåg är att alla kommentarer utökar java.lang.annotation.Annotation interface. Annoteringar kan inte innehålla någon utvidgningsklausul.
Inbyggda Java-kommentarer
I Java finns det inbyggda kommentarer som @Override, @Drecrecated, @SuppressWarnings som är utformade för ett specifikt syfte och används i en av ovanstående situationer, till exempel endast för klassen eller endast för metoden, etc.
Exempel 1 - Övergå
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();
)
)
Produktion
Exempel 2 - Utvärderat
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();
)
)
Produktion
Meta-kommentarer
Det finns fem typer av meta-anteckningar:
- Dokumenterad - Den informerar om att medlemmen eller variabeln eller klassen som använder denna kommentar måste dokumenteras av Javadoc eller andra liknande verktyg som finns tillgängliga.
- Mål - Det används för att ange vid vilken typ annotationen används. Det används mest tillsammans med dina anpassade kommentarer.
- Ärvt - Det markerar anteckningen som ska ärvas till underklassen.
- Retention - Det anger hur länge anteckningar med den annoterade typen ska behållas. Det tar argumentet Retention Policy vars möjliga värden är: Källa, klass och RUNTIME.
- Repeterbar - Detta informerar om att annoteringstyper vars förklaring den kommenterar är repeterbara.
Exempel - Dokumentation och lagring
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");
)
)
Produktion
Förklaring
RetentionPolicy.RUNTIME - Detta värde anger att anteckningsvärdet ska vara tillgängligt under körning för inspektion via java-reflektion.
Kör kommandot Javadoc för att visa dokumentationen för din kod.
Typer av anteckningar
Det finns tre kategorier av anteckningar och det finns följande:
1. Marköranteckningar - Dessa typer av anteckningar används som en deklaration för att meddela utvecklaren vad nedanstående funktion eller klass handlar om, dvs den delar extra information om funktionen eller klassen som om funktionen åsidosätter en annan funktion eller är funktionen uttagen, etc. @Override, @ Uppdaterad betraktas som marköranteckningar.
Exempel: DemoAnnotation ()
2. Kommentarer med enstaka värden - Den här typen av anteckningar tar värde för att ange det värde för den medlem som annotationen är placerad framför och behöver därför inte ange namnet på den medlemmen.
Exempel: DemoAnnotation (“custId123”)
3. Fullständiga kommentarer - Den här typen av kommentarer innehåller flera värden, par, medlemmar.
Exempel: DemoAnnotation (kategori = ”Leksaker”, värde = 1500)
Beställnings
Anpassade kommentarer skapas av användargränssnittet, följt av ett annotationsnamn som vi kommer att se i exemplet nedan.
Fil 1: Anpassad kommentar definierad
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: Huvudklass som kallar anpassad kommentarklass
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();
)
)
)
Produktion
Slutsats
I den här artikeln lärde vi oss vad som är javaanteckningar och deras typer med exempel, tillsammans såg vi exempel på inbyggda kommentarer tillhandahållna av java och kodade våra anpassade kommentarer.
Vi lärde oss att anteckningar är användbara vid standardisering av koden och också hjälper till att bättre förstå koden och dess struktur.
Rekommenderade artiklar
Detta är en guide till Java-kommentarer. Här diskuterar vi hur man bygger in Java-kommentarer med de givna exemplen och utgångar. Du kan också titta på följande artiklar för att lära dig mer -
- Variabler i Java
- Mönster i Java
- Snabbsortering i Java
- Bästa Java-kompilatorer
- exempel av i Java med exempel