Bevezetés Jelölések a Java-ban
A jelöléseket a Java Development Kit (JDK) 1.5 verziójában vezették be vagy tették elérhetővé. A Java-ban található kommentárok további információt nyújtanak a kódszerkezetben jelen lévő adatokról, azaz adatokról vannak adatok, amelyeket metaadatokként is ismertek.
Milyen kommentárok vannak a Java-ban?
A kommentárok segítenek a metaadatok kódos meghatározásában egységes módon. A kommentárok emellett segítséget nyújtanak abban, hogy a java-fordító számára kövesse az utasításokat a Java-kód fordításakor.
A kommentárok használatakor a '@' jelet, majd a kommentár nevét követi, így a fordító annotációként kezeli. Fontos megjegyezni, hogy a kommentárokat még mielőtt hozzáadhatják -
- Osztályú nyilatkozat
- Tagváltozói nyilatkozat
- Kivitelező nyilatkozata
- Módszernyilatkozat
- Egy paraméter deklaráció
- Helyi változónyilatkozat.
Fontos megjegyezni, hogy minden kommentár kiterjeszti a java.lang.annotation.Annotation felületet. A kommentárok nem tartalmazhatnak kiterjesztési záradékot.
Beépített Java kommentárok
A Java-ban vannak olyan beépített kommentárok, mint például a @Override, @Deprecated, @SuppressWarnings, amelyeket egy adott célra terveztek, és a fenti helyzetek egyikében használják, például csak az osztály számára vagy csak a módszerhez, stb.
1. példa - felülbírálás
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();
)
)
Kimenet
2. példa - Eltávolítva
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();
)
)
Kimenet
Meta kommentárok
Ötféle meta-kommentár létezik:
- Dokumentált - tájékoztatja, hogy a tagot, a változót vagy az osztályt, amely ezt a kommentárt használja, Javadocnak vagy más hasonló eszköznek kell dokumentálnia.
- Cél - annak meghatározására szolgál, hogy melyik típuson használja a kommentárt. Leginkább az egyéni jelöléseivel együtt használja.
- Öröklött - A jelölést az alosztály számára örököltként jelöli.
- Megőrzés - azt jelzi, hogy mennyi ideig kell megőrizni a megjegyzett típushoz tartozó megjegyzéseket. Szükség van a megőrzési irányelv érvelésére, amelynek lehetséges értékei: SOURCE, CLASS és RUNTIME.
- Megismételhető - Ez azt jelenti, hogy a megjegyzéstípusok, amelyek nyilatkozatát megismételik, megismételhetők.
Példa - dokumentáció és megőrzés
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");
)
)
Kimenet
Magyarázat
RetentionPolicy.RUNTIME - Ez az érték határozza meg, hogy a kommentár értékének rendelkezésre kell állnia futási időben, a java reflektálás útján történő ellenőrzéshez.
Futtassa a Javadoc parancsot a kód dokumentációjának megtekintéséhez.
A kommentárok típusai
A kommentárok három kategóriája van, és a következők:
1. Jelölő jelölések - Az ilyen típusú kommentárok deklarációként használják, hogy értesítsék a fejlesztőt az alábbi függvény vagy osztály lényegéről, azaz extra információkat osztanak meg a függvényről vagy osztályról, például arról, hogy a függvény felülbírálja-e egy másik funkciót, vagy a funkció elavult, stb. A @Oride, a @Deprecated jelölő jelöléseknek számítanak.
Példa: DemoAnnotation ()
2. Egyértékű jelölések - Az ilyen típusú kommentár értékét adja meg annak a tagnak az értékének meghatározásához, amelyre a kommentár elé kerül, ezért nem kell megadnia a tag nevét.
Példa: DemoAnnotation („custId123”)
3. Teljes kommentárok - Az ilyen kommentárok több értéket, párt, tagot tartalmaznak.
Példa: DemoAnnotation (kategória = „Játékok”, érték = 1500)
Egyedi
Az egyéni kommentárokat a felhasználói felület hozza létre, amelyet egy kommentár neve követ, amint azt az alábbi példában látjuk.
1. fájl: Meghatározott egyéni kommentár
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; )
)
2. fájl: Fő osztály, amely az Egyedi kommentár osztályt hívja
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();
)
)
)
Kimenet
Következtetés
Ebben a cikkben példákkal megismertük a java-kommentárokat és azok típusait, a java által nyújtott beépített kommentárok példáit és az egyedi jelöléseink kódolását.
Megtudtuk, hogy a kommentárok hasznosak a kód egységesítésében, és segítik a kód és annak szerkezetének jobb megértését.
Ajánlott cikkek
Ez egy útmutató a Java kommentárokhoz. Itt tárgyaljuk, hogyan lehet a beépített Java-kommentárokat a megadott példákkal és kimenetekkel összehasonlítani. Lehet, hogy megnézi a következő cikkeket is, ha többet szeretne megtudni -
- Változók Java-ban
- Minta a Java-ban
- Gyors rendezés Java-ban
- A legjobb Java fordítók
- Például Java Java példában