J2SE1.5 注释语法

J2SE

  说起注解语法,对于任何一个Java开发人员来说都已经耳熟能详了,我们每天都在使用着 @author, @param,等等编写注释,然后用javadoc生成文档。Java的这种方便的文档生成方法受到了开发者的普遍赞誉。而从JDK1.5开始,注释语法提供了更为强大的功能。

  我们先谈谈注释语法本身,它有时候也称为meta-data :“描述数据的数据” 。一般来说它们可以被用来生成文档,检查代码间依赖关系,帮助编译器作语法检查。时下比较流行的工具有Xdoclet等。对于文档生成早已经有了javadoc工具的完美表现,而对于代码检查,如今java也提供了语言级的支持。

  我们知道,javadoc是通过提取java源文件中的标签信息来生成文档。所以要学习新的注释语法,们首先要熟悉的就是新增的标签。新的注释语法支持两种标签,系统标准标签和用户自定义标签。标签的符号也原先一样,@符号加上标签名字。我们先从JDK1.5自带的标准标签说起。

  首先介绍@override , 也不用多罗嗦,顾名思义了,就是用来说明方法覆载的。我们假设有一个子类必须要覆载父类的方法.

  ================================================================================
  public class Parent{

  public void foo(){
  System.out.println("Original Implementation of foo");
  }

  }

  public class Child extends Parent{

  @Override
  public void foo(){
  System.out.println("Overide Implementation of foo");
  }

  }
  ================================================================================

  目前为止我们看不出来这个@Override给我们带来了任何好处,所以我们先说说加个这个标签后,我们用javac编译的时候编译器执行了些什么呢?编译器会检查这个方法,然后从父类查找是否有这个方法,否则就编译出错。这个特性可以帮助我们避免一些低级错误。上面这个例子,子类想覆载foo()方法,不过你可能一时疏忽把它写成了fob(), 对于这样的”低级错误”,如果你没有在前期就发现的话,到系统集成测试的时候,可能会化上你几个小时甚至一两天去找出这样的bug。现在好了,编译器在编译的时候就会给出错误,

  Child.java:3: method does not override a method from its superclass
  @Override
  ^
  1 error

  怎么样,这个功能还不错吧。
   看过了标准标签的使用方法,我们来看看用户自定义标签。首先介绍@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();
  }
  }
  }
  ===============================================================================

  需要注意的一点是,在执行这段代码之前我们还有一点小工作要做,还需要给我们的自定义标签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新注释语法的信息,可以访问[link=http://java.sun.com/j2se/1.5.0/docs/guide/language/annotations.html]。

  以上代码在win2k + j2se5 GA下通过。

时间: 2024-09-18 05:24:33

J2SE1.5 注释语法的相关文章

J2SE1.5 注释语法_JSP编程

说起注解语法,对于任何一个Java开发人员来说都已经耳熟能详了,我们每天都在使用着 @author, @param,等等编写注释,然后用javadoc生成文档.Java的这种方便的文档生成方法受到了开发者的普遍赞誉.而从JDK1.5开始,注释语法提供了更为强大的功能. 我们先谈谈注释语法本身,它有时候也称为meta-data :"描述数据的数据" .一般来说它们可以被用来生成文档,检查代码间依赖关系,帮助编译器作语法检查.时下比较流行的工具有Xdoclet等.对于文档生成早已经有了ja

J2SE 1.5的注释语法

说起注解语法,对于任何一个Java开发人员来说都已经耳熟能详了,我们每天都在使用着 @author, @param,等等编写注释,然后用javadoc生成文档.Java的这种方便的文档生成方法受到了开发者的普遍赞誉.而从JDK1.5开始,注释语法提供了更为强大的功能. 我们先谈谈注释语法本身,它有时候也称为meta-data :"描述数据的数据" .一般来说它们可以被用来生成文档,检查代码间依赖关系,帮助编译器作语法检查.时下比较流行的工具有Xdoclet等.对于文档生成早已经有了ja

jsp基础语法 二 注释的使用

我的一个同学问我,java中有"//"这个样的注释,用起来挺方便的,jsp的注释难道不是这个吗?用"//"在jsp中不行. 对于学习了这么长时间的jsp,注释是最基本的.jsp中的注释不同于java. 在jsp中支持两种注释,一种是显示注释,这种注释客户端是允许看见的,另外一种注释是隐式注释,此种注释客户端是无法看见的. 显示注释语法: <!--注释内容--> 隐式注释语法: 格式一:// 注释,单行注释: 格式二:  /* 注释 */,多行注释: 格式

XML轻松学习手册(4)XML语法

xml|语法 第四章 XML语法 提纲: 一.XML语法规则 二.元素的语法 三.注释的语法 四.CDATA的语法 五.Namespaces的语法 六.entity的语法 七.DTD的语法 通过前面三章的学习,我们已经对什么是XML,它的实现原理以及相关的术语有所了解.接下来我们就开始学习XML的语法规范,动手写自己的XML文档. 一.XML语法规则 XML的文档和HTML的原代码类似,也是用标识来标识内容.创建XML文档必须遵守下列重要规则:规则1:必须有XML声明语句这一点我们在上一章学习时

在C#使用XML注释

xml     简介     大多数程序员可能都听说过Java自带的一个工具JavaDoc:使用它可以自动地为你的代码生成HTML文档.C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML.不过使用XML会使得文档更加灵活.     注释语法     为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头.在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签.你定制的标签将会在随后加入到生成的注释文档中.     预定义的

ASP.NET 2.0 Web窗体语法指导

asp.net|web|语法 ASP.NET Web窗体页面是一个宣告式的文本文件,扩展名是.aspx.除了静态的内容之外,你还可以使用八种不同的语法标记元素.这一部分回顾这些语法元素并提供了一些使用方法示例. 呈现代码的语法:<% %>和<%= %> 代码呈现块用<% ... %>元素表示,它允许你控制呈现的内容,在Web窗体页面执行的显示阶段执行.下面的例子演示了如何使用它们循环显示HTML的内容. <%@ Page Language="VB&quo

亲密接触ASP.Net(2) ASP+的语法

上一节 ,我们简单介绍了ASP+的配制环境,我们这一节来谈谈ASP+的语法.其实当你装好NGWS后,他所带的文档是最好的学习ASP+的教程,要你E文足够好,以及很好的耐性,学习ASP+不是难事啦.我们这些家伙也是从这里学了很多的,这篇关于ASP+语法的文章,大多数也来自于M$的原文,最可惜的就是我们的服务器不能装上NGWS,有些例子,大家不能看到执行结果,不太好.不过有些地方,我会把执行结果显示出来的.我们开始这一节吧:) 一个ASP+页面的后缀名是".ASPX".它能够包含八种不同的

在C#使用XML注释 选择自 lotusswan 的 Blog

xml 在C#使用XML注释 简介 大多数程序员可能都听说过Java自带的一个工具JavaDoc:使用它可以自动地为你的代码生成HTML文档.C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML.不过使用XML会使得文档更加灵活. 注释语法 为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头.在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签.你定制的标签将会在随后加入到生成的注释文档中. 预定义的标签 用处 <c>

在C#中使用XML注释

大多数程序员可能都听说过Java自带的一个工具JavaDoc:使用它可以自动地为你的代码生成HTML文档.C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML.不过使用XML会使得文档更加灵活. 注释语法 为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头.在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签.你定制的标签将会在随后加入到生成的注释文档中. 预定义的标签 用处 <c> 将说明中的文本标记为代码 <