JAVA技巧：Java注释的使用和定义

会计考友

元数据年夜metadata一词译来，就是“关于数据的数据”的意思。越来越的开源框架都供给了“元数据”撑持了，其实也就是注释撑持。今天系统进修一下Java注释(Java元数据)。本文内容不限于Javadoc的注释。
8 ]& R0 O! E: d) t: E　　1.什么是Java元数据，有什么浸染?
　　元数据，就是“关于数据的数据”。功能也有良多啦。你可能用过Javadoc的注释自动生成文档。这就是元数据功能的一种。总的来说，元数据可以用来建树文档，跟踪代码的依靠性，执行编译时名目搜检，庖代已有的设置装备摆设文件(如Hibernate也供给了注释设置装备摆设)
　　注释有3中根基类型
　　a.标识表记标帜注释 --没有变量，只有名称标识。例如 @annotation
/ ]( S9 [7 o7 T0 x2 M6 J8 u1 N; A　　b.单一值注释 --在标识表记标帜注释的基本上供给一段数据。如 @annotation(“data”)
" l* E& F. @* [$ t9 V: k　　c.完整注释 --可以搜罗多个数据成员，每个数据成员由名称和值组成。
. v; s  D" Y. g; b1 E" g- D* X　　@annotation(val1="data1",val2="data2")
" Y( [0 }1 L9 q1 S3 G, U, |' y- \) q　　2.Java的“注释”
, S0 \! n2 j+ ^0 |* O9 l　　Java中供给3个内置注释类型
) y$ i: B: b% V8 k/ P　　a. Override ，只能用于体例(不能用于类，包声明或者其他机关)
& d6 t+ I# v7 K0 C$ T) G1 z5 ?% j　　浸染：可以保证编译时辰Override函数的声明正确性
　　用法：@Override
2 n5 s3 W4 V6 n/ ~1 O$ t　　public void fun(){..}
　　b.Deprecated 同样只能浸染与体例
　　浸染：对不应再使用的体例进行注解
& M% t+ ]7 }  X4 A0 |1 ~　　用法：@Deprecated public void fun{...} //它们嗣魅这个注释跟函数要统一行
. _9 `+ H2 X" s* Z& N　　c.SupressWarnings 可以注释一段代码
5 d! @1 k; }1 Q+ F  V4 M　　浸染：封锁特定的警告信息，例如你在使用泛型的时辰未指定类型
　　用法： @SupressWarnings(value=http://www.qnr.cn/pc/java/fudao/jichu/200911/{"unchecked"})
　　..代码
　　Java中还供给了四种元注释，专门负责注释其他的注释
　　@Target 暗示该注释可以用于什么处所。可用的ElementType参数搜罗：
　　CONSTRUCTOR : 机关器的声明
　　FIELD : 域声明(搜罗enum实例)
3 C* ~. K  f0 @  o+ }7 y　　LOCAL_VARIABLE : 局部变量声明
+ W% V. C; H  J0 O+ \3 a: d3 l: C　　METHOD : 体例声明
3 P% [! K) Z5 C6 A6 n　　PACKAGE : 包声明
5 m( ]4 F% R" U9 j8 s　　PARAMETER : 参数声明
2 d2 t& M: U$ H. M$ \* ]  w% r3 w+ g　　TYPE : 类、接口 (搜罗注解类型) 或enum声明
( `2 o; |# ?$ p　　@Retention 暗示需要在什么级别保留该注释信息。可选的RetentionPoicy参数搜罗：
　　SOURCE : 注释将被编译器丢失踪
　　CLASS : 注释在class文件中可用，但会被VM丢弃
2 d- z: h( ^  y9 y4 T　　RUNTIME : VM将在运行时也保留注释，是以可以经由过程反射机制篡夺注释的信息。
　　@Documented 将注释包含在JavaDoc中
; |; k* r. `+ l- ^. d　　@Inheried 许可子类担任父类中的注释。
　　3. 在Java中界说自己的注释
　　Java说话撑持一种新的类型——注释类型(annotation type)，跟通俗类差不多，在类中以符号( @ )的形式注释其他 Java 代码
　　下面将经由过程一个简单的例子来实现(代码是Brett McLaughlin 的)
　　@interface 声名
+ D5 f1 N6 {! {0 f% m  u　　i.简单的注释类型
　　package com.oreilly.tiger.ch06; /** * Marker annotation to indicate that a method or class * is still in progress. */ public @interface InProgress { }
" C' T/ _( `! e: g/ ?8 s8 \　　ii.使用定制的注释类型
- r& T! ^4 V" a' Z　　@com.oreilly.tiger.ch06.InProgress public void calculateInterest(float amout,float rate) { //Need to finish this method later }
　　iii.添加成员
　　package com.oreilly.tiger.ch06; /** * Marker annotation to indicate that a method or class * is still in progress. */ public @interface InProgress { String value(); } @com.oreilly.tiger.ch06.InProgress @TODO("Figure out the amount of interest per month") //或者@TODO(value="http://www.qnr.cn/pc/java/fudao/jichu/200911/Figure out the amount of interest per month") public void calculateInterest(float amount,float rate) { }
, d  M2 `& s* U4 s2 `, \$ v+ @2 K　　iv.设置默认值
　　package com.oreilly.tiger.ch06; public @interface GroupTODO { public enum Serverity { CRITICAL,IMPORTANT,IRIVIAL,DOCMENTATION }; Severity severity() default Severity.IMPORTANT; String item (); String assignedTo(); String dateAssigned(); } }
# U4 `. V7 K( q1 t3 e　　v.使用默认值
! Q9 \8 \* {: Z$ ?　　@com.oreilly.tiger.ch06.InProgress @GroupTODO( item="Figure out the amount of interest per month", assignedTo = "Brett McLaughlin", dateAssigned = "08/04/2004" ) public void calculateInterest(float amount, float rate) { //Need to finish this method later }
. Q+ T3 _3 m/ h) D2 F' n0 S　　vi.改写默认值
　　@com.oreilly.tiger.ch06.InProgress @GroupTODO { severity = GroupTODO.Severity.DOCUMENTATION, item = "Need to explain how this rather unusal method works", assignedTo = "Jon Stevens", dateAssigned = "07/30/2004" }
8 B. j- [# u# T, u% \. p　　这样就对Java元数据/Java注释进行了总结。