javadoc注释标签语法
2015-01-10 12:17
211 查看
本文为大家讲解的是javadoc注释标签的语法,感兴趣的同学参考下。
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
@override 说明方法覆载
@interface, 它用于定义新的注释类型(annotation type)。新建一个注释类型看起来和定义一Interface 没有什么两样,
MyTag.java用于新建一个用户自定义标签,代码如下:
package tiger.annotation;
/**
* 用户自定义标签 MyTag
*/
public @interface MyTag { }
定义了一个tag之后,我们就可以在任何java文件中使用这个tag了,
import tiger.annotation.MyTag;
public class TagTest{
@MyTag
public void testTag(){
}
}
注释类型还可以有成员变量,
package tiger.annotation;
/**
* 用户自定义标签 带有成员变量的MyTag
*/
public @interface MyTag {
String name();
int age();
}
然后我们可以这么使用这个标签,
@MyTag(name="MyTag",age=1)
public void testTag(){
}
使用标签最终是为了帮助开发人员提取注释信息,然后根据不同需求做进一步处理,下面我们来看看如何获取注释信息。
import java.lang.annotation.Annotation;
import tiger.annotation.MyTag;
public class TagTest{
@MyTag(name="MyTag",age=1)
public void test(){
}
public static void main(String[] args){
TagTest tt = new TagTest();
try {
Annotation[] annotation =tt.getClass().getMethod("test").getAnnotations();
for (Annotation tag :annotation) {
System.out.println("Tag is:" + tag);
System.out.println("tag.name()" + ((MyTag)tag).name());
System.out.println("tag.age()" + ((MyTag)(tag)).age());
}
} catch(NoSuchMethodException e) {
e.printStackTrace();
}
4000
}
}
需要注意的一点是,在执行这段代码之前我们还有一点小工作要做,还需要给我们的自定义标签MyTag加上一个说明标签,@ Retention, 表明注释信息将可以在运行时刻通过反射机制得到。如果不加入这个标签,上面的代码将没有任何输出。修改以后的MyTag如下,
/**
* 用户自定义标签 带有成员变量的MyTag
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
String name();
int age();
}
然后我们执行TagTest可以得到输出如下,
Tag is:@tiger.annotation.MyTag(name=MyTag, age=1)
tag.name()MyTag
tag.age()1
好了,Tiger新的注释语法基本用法就这么简单,基本用法虽然简单,但是获取注释信息之后如何处理确很值得推敲,我们可以用他们来做一些语法检查,文件 相关性检查,进行各种统计等等。
关于更多的Tiger新注释语法的信息,可以访问http://java.sun.com/j2se /1.5.0/docs/guide/language/annotations.html。
原文地址:http://www.adminso.com/articles/view/92181
(站长搜索- http://www.adminso.com/websites -网站收录,为站长提供分类最全,最专业的网站收录平台!)
@author 对类的说明 标明开发该类模块的作者
@version 对类的说明 标明该类模块的版本
@see 对类、属性、方法的说明 参考转向,也就是相关主题
@param 对方法的说明 对方法中某参数的说明
@return 对方法的说明 对方法返回值的说明
@exception 对方法的说明 对方法可能抛出的异常进行说明
@override 说明方法覆载
@interface, 它用于定义新的注释类型(annotation type)。新建一个注释类型看起来和定义一Interface 没有什么两样,
MyTag.java用于新建一个用户自定义标签,代码如下:
package tiger.annotation;
/**
* 用户自定义标签 MyTag
*/
public @interface MyTag { }
定义了一个tag之后,我们就可以在任何java文件中使用这个tag了,
import tiger.annotation.MyTag;
public class TagTest{
@MyTag
public void testTag(){
}
}
注释类型还可以有成员变量,
package tiger.annotation;
/**
* 用户自定义标签 带有成员变量的MyTag
*/
public @interface MyTag {
String name();
int age();
}
然后我们可以这么使用这个标签,
@MyTag(name="MyTag",age=1)
public void testTag(){
}
使用标签最终是为了帮助开发人员提取注释信息,然后根据不同需求做进一步处理,下面我们来看看如何获取注释信息。
import java.lang.annotation.Annotation;
import tiger.annotation.MyTag;
public class TagTest{
@MyTag(name="MyTag",age=1)
public void test(){
}
public static void main(String[] args){
TagTest tt = new TagTest();
try {
Annotation[] annotation =tt.getClass().getMethod("test").getAnnotations();
for (Annotation tag :annotation) {
System.out.println("Tag is:" + tag);
System.out.println("tag.name()" + ((MyTag)tag).name());
System.out.println("tag.age()" + ((MyTag)(tag)).age());
}
} catch(NoSuchMethodException e) {
e.printStackTrace();
}
4000
}
}
需要注意的一点是,在执行这段代码之前我们还有一点小工作要做,还需要给我们的自定义标签MyTag加上一个说明标签,@ Retention, 表明注释信息将可以在运行时刻通过反射机制得到。如果不加入这个标签,上面的代码将没有任何输出。修改以后的MyTag如下,
/**
* 用户自定义标签 带有成员变量的MyTag
*/
@Retention(RetentionPolicy.RUNTIME)
public @interface MyTag {
String name();
int age();
}
然后我们执行TagTest可以得到输出如下,
Tag is:@tiger.annotation.MyTag(name=MyTag, age=1)
tag.name()MyTag
tag.age()1
好了,Tiger新的注释语法基本用法就这么简单,基本用法虽然简单,但是获取注释信息之后如何处理确很值得推敲,我们可以用他们来做一些语法检查,文件 相关性检查,进行各种统计等等。
关于更多的Tiger新注释语法的信息,可以访问http://java.sun.com/j2se /1.5.0/docs/guide/language/annotations.html。
原文地址:http://www.adminso.com/articles/view/92181
(站长搜索- http://www.adminso.com/websites -网站收录,为站长提供分类最全,最专业的网站收录平台!)
相关文章推荐
- Javadoc注释标签语法
- doxygen注释语法(一):JavaDoc注释风格、文件头和类注释
- xml--语法02-- 元素/标签/element,属性,注释
- thinkphp的内置标签不能注释,注释掉会提示XML标签语法错误
- 2.1php标签,语法,注释
- Razor语法生成标签
- 黑马程序员—————Java基础语法(1)----关键字、标示符、注释、常量、进制、变量、运算符
- sql 缺少注释的结尾标记 '*/'。 '*' 附近有语法错误。 在注释中包含 GO 命令会生成一个错误信息
- JScript多语言语法加亮引擎改进(修正多行注释识别)
- css样式标签和js语法属性区别
- Html基础语法之网页架构标签的用法
- javadoc中文档注释标记的使用
- javadoc注释文档
- javadoc的注释
- javadoc注释规范
- 从0开始 2. JAVA基础语法(MyEclipse引入,注释,标识符命名规则及Java中的关键字)
- Python笔记第1章,流程控制,用户交互,语法要求,变量,字符,注释,模块导入的使用
- javaDoc标签
- HTML新人基础学习1.2—HTML的常用的标签语法
- 网站开发进阶(四十八)JSP c:choose标签注释学习