Uvod Bilješke na Javi
Bilješke su uvedene ili postale dostupne u 1.5 verziji Java Development Kit-a (JDK). Bilješke u Javi pružaju više informacija o podacima koji su prisutni u strukturi koda, tj. To su podaci o podacima također poznatim kao metapodaci.
Što su napomene na Javi?
Bilješke pomažu u definiranju metapodataka u kodu na standardizirani način. Također, napomene pomažu u pružanju upute vašem java prevoditelju koje trebate slijediti tijekom sastavljanja tog java koda.
Pri korištenju napomena koristimo znak '@', a zatim slijedi naziv vaše napomene, tako da prevoditelj to tretira kao napomenu. Važno je napomenuti da se napomene mogu dodati prije,
- Izjava o razredu
- Izjava o varijabli člana
- Izjava konstruktora
- Izjava o metodi
- Deklaracija parametra
- Deklaracija lokalne varijable.
Važne točke koje morate zapamtiti su da sve napomene proširuju sučelje java.lang.annotation.Anonotation. Također, napomene ne mogu sadržavati klauzulu o proširenju.
Ugrađene Java napomene
U Javi se nalaze ugrađene napomene poput @Override, @Deprecated, @SuppressWarnings koje su dizajnirane za određenu svrhu i koriste se u jednoj od gore navedenih situacija, na primjer, samo za klasu ili samo za metodu, itd
Primjer # 1 - Prekoračenje
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();
)
)
Izlaz
Primjer br. 2 -prepoznat
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();
)
)
Izlaz
Meta napomene
Postoji pet vrsta meta-napomena:
- Dokumentirano - Obavještava da člana ili varijablu ili klasu koja koristi ovu napomenu treba dokumentirati Javadoc ili bilo koji drugi sličan alat na raspolaganju.
- Cilj - služi za određivanje vrste napomena koja se koristi. Uglavnom se koristi zajedno s vašim prilagođenim napomenama.
- Nasljeđeno - označava napomenu koja se nasljeđuje na podrazredu.
- Zadržavanje - Pokazuje koliko dugo treba da se bilježe s napomenutim tipom. Potrebna je argumenta zadržavanja čija su moguće vrijednosti: IZVOR, RAZRED i RUNTIME.
- Ponovljivo - Ovo obavještava da su vrste napomena čija se deklaracija navodi mogu ponoviti.
Primjer - dokumentacija i zadržavanje
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");
)
)
Izlaz
Obrazloženje
RetentionPolicy.RUNTIME - Ova vrijednost određuje da bi vrijednost napomena trebala biti dostupna za vrijeme izvođenja, za pregled putem refleksije Java.
Pokrenite naredbu Javadoc za pregled dokumentacije vašeg koda.
Vrste napomena
Postoje tri kategorije napomena i postoje sljedeće:
1. Napomene s markerima - ove se vrste bilješki koriste kao deklaracija za obaviještavanje razvojnog programera o čemu se radi u donjoj funkciji ili klasi, tj. Dijeli dodatne informacije o funkciji ili klasi poput primjerice je li funkcija nadjačala drugu funkciju ili je funkcija zastarjela itd. @ Override, @Depreposed smatraju se napomenama s markerima.
Primjer: DemoAnnotation ()
2. Napomene s pojedinačnom vrijednošću - Ova vrsta napomena uzima vrijednost da bi se odredila ta vrijednost za tog člana kojem je napomena stavljena ispred, te stoga ne treba navesti ime tog člana.
Primjer: DemoAnnotation ("custId123")
3. Kompletne napomene - Ova vrsta napomena uzima više vrijednosti, parova, članova.
Primjer: DemoAnnotation (kategorija = "Igračke", vrijednost = 1500)
Prilagođen
Prilagođene napomene stvaraju korisničko sučelje, a slijedi naziv napomene kao što ćemo vidjeti u donjem primjeru.
Datoteka 1: Definirana prilagođena napomena
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; )
)
Datoteka 2: Glavna klasa koja naziva korisničku klasu napomena
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();
)
)
)
Izlaz
Zaključak
U ovom smo članku naučili o javanskim napomenama i njihovim vrstama s primjerima, a vidjeli smo primjere ugrađenih napomena koje je Java dao i kodirali naše prilagođene napomene.
Saznali smo da su komentari korisni u standardiziranju koda te također pomažu u boljem razumijevanju koda i njegove strukture.
Preporučeni članci
Ovo je vodič za Java komentare. Ovdje smo razgovarali o ugrađivanju Java napomena s danim primjerima i izlazima. Možete također pogledati sljedeće članke da biste saznali više -
- Varijable u Javi
- Uzorci u Javi
- Brzo sortiranje na Javi
- Najbolji Java sastavljači
- instanceOf u Javi s primjerom