Uvod Opombe v Javi
Obvestila so bila uvedena ali na voljo v 1.5 različici Java Development Kit (JDK). Obvestila v Javi zagotavljajo več informacij o podatkih, ki so prisotni v strukturi kode, tj. Podatki o podatkih, znanih tudi kot metapodatki.
Kaj so komentarji na Javi?
Obvestila pomagajo pri definiranju metapodatkov v kodi na standardiziran način. Opombe pomagajo pri zagotavljanju navodil za prevajalnik jave, ki jih morate upoštevati pri sestavljanju te kode Java.
Ko uporabljamo pripise, uporabimo znak '@' in nato sledi ime vaše pripombe, tako da prevajalnik to obravnava kot pripis. Pomembno je opozoriti, da lahko pripombe dodamo prej,
- Razredna izjava
- Izjava spremenljivke člana
- Izjava konstruktorja
- Izjava o metodi
- Izjava parametra
- Deklaracija lokalne spremenljivke.
Pomembne točke, ki si jih je treba zapomniti, so, da vse opombe razširjajo vmesnik java.lang.annotation.Anotatation. Tudi obvestila ne morejo vsebovati nobene klavzule o podaljšanju.
Vgrajene Java Opombe
V Javi so vgrajene pripombe, kot so @Override, @Deprecated, @SuppressWarnings, ki so zasnovane za določen namen in se uporabljajo v eni od zgornjih situacij, na primer samo za razred ali samo za metodo, itd.
Primer # 1 - Preveri
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();
)
)
Izhod
Primer # 2 - Določen
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();
)
)
Izhod
Meta komentarji
Obstaja pet vrst metapodatkov:
- Dokumentirano - sporoča, da mora član ali spremenljivka ali razred, ki uporablja to obvestilo, dokumentirati Javadoc ali katero koli drugo podobno orodje.
- Cilj - Uporablja se za določitev, za katero vrsto obvestila se uporablja. Večinoma se uporablja skupaj s pripisi po meri.
- Dedovan - označuje opombo, ki jo je treba podedovati v podrazred.
- Zadrževanje - Nakazuje, kako dolgo je treba obdržati opombe z označeno vrsto. Vzame argument zadrževalne politike, katerega možne vrednosti so: SOURCE, CLASS in RUNTIME.
- Ponovljivo - S tem se sporoči, da so vrste opomb, katerih izjava označuje, ponovljive.
Primer - Dokumentacija in hramba
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");
)
)
Izhod
Pojasnilo
RetentionPolicy.RUNTIME - Ta vrednost določa, da mora biti vrednost opombe na voljo med izvajanjem, za pregled preko java refleksije.
Zaženite ukaz Javadoc in si oglejte dokumentacijo kode.
Vrste komentarjev
Obstajajo tri kategorije komentarjev in so naslednje:
1. Napomene z označevalci - te vrste obvestil se uporabljajo kot deklaracija za obveščanje razvijalca o tem, kaj gre spodaj o funkciji ali razredu, tj. Deli dodatne informacije o funkciji ali razredu, na primer, ali funkcija preglasi drugo funkcijo ali je funkcija opuščena itd. @ Override, @Depreposed se štejejo za pripombe označevalcev.
Primer: DemoAnnotation ()
2. Pripombe z eno samo vrednostjo - Ta vrsta obvestil ima vrednost, da določi to vrednost za tistega člana, za katerega je pripis postavljen pred in zato ni treba določiti imena tega člana.
Primer: DemoAnnotation („custId123“)
3. Popolne opombe - ta vrsta obvestil vključuje več vrednosti, parov, članov.
Primer: DemoAnnotation (kategorija = "Igrače", vrednost = 1500)
Po meri
Pripombe po meri ustvari uporabniški vmesnik, ki mu sledi ime komentarja, kot bomo videli v spodnjem primeru.
Datoteka 1: Opomba po meri
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: Glavni razred, ki kliče razred komentarjev po meri
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();
)
)
)
Izhod
Zaključek
V tem članku smo spoznali, kaj so komentarji java in njihove vrste s primeri, poleg tega pa smo videli primere vgrajenih pripisov, ki jih je zagotovil java, in kodirali naše pripise po meri.
Izvedeli smo, da so komentarji koristni pri standardizaciji kode in pomagajo pri boljšem razumevanju kode in njene strukture.
Priporočeni članki
To je vodnik za Javne komentarje. Tukaj razpravljamo o tem, kako vgraditi Java opombe z danimi primeri in rezultati. Za več informacij si lahko ogledate tudi naslednje članke -
- Spremenljivke na Javi
- Vzorci na Javi
- Hitro razvrščanje v Javi
- Najboljši Java Compilers
- instanceOf v Javi s Primerjem