J2SE1.5 注释语法

说起注解语法,对于任何一个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下通过。

(0)

相关推荐

  • J2SE1.5 注释语法

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

  • PHP注释语法规范与命名规范详解篇

    HP注释规范 注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范. "php是一门及其容易入门的语言,刚入门的新手不到几分钟的时间可能就会用echo打印出一个hello world !但是他是真正的程序员吗?怎么来定义程序员呢?如果想真正成为一个程序员,那么就必须遵循一套程序书写规范," 我们经常编写一些函数,但是这些函数可能也只有自己能看得懂,甚至过一段时间自己也不认识自己写的了,那么怎么办呢?最好的办法当然是给给自己的代码加上注释.

  • MySQL 语句注释方式简介

    MySQL支持三种注释方式: 1.从'#'字符从行尾. 2.从'-- '序列到行尾.请注意'-- '(双破折号)注释风格要求第2个破折号后面至少跟一个空格符(例如空格.tab.换行符等等). 3.从/*序列到后面的*/序列.结束序列不一定在同一行中,因此该语法允许注释跨越多行. 下面的例子显示了3种风格的注释: //在mysql中如何写注释语句 mysql> SELECT 1+1; # 这个注释直到该行结束 mysql> SELECT 1+1; -- 这个注释直到该行结束 mysql>

  • Lua简介、编译安装教程及变量等语法介绍

    公司业务有用到Lua,与nginx结合起来实现高性能的web应用,想去弄懂这方面的知识,就去了解学习了下Lua,欢迎大咔们指教. 1. Lua介绍 Lua是一门简单的编程语言,它的优势在于可以整合C++的模块来扩展自身的功能,使用数百行或更少的代码来解决复杂的问题.具有的特征有: 1.1. 可扩展性:Lua从一开始就被设计成易于扩展的语言,很多功能都是通过外部库来实现的,很容易与其他编程语言如C.C++.Java等等进行交互. 1.2. 简洁: Lua十分简洁,但是功能强大,易于学习,很适合小规

  • MySQL与Oracle差异比较之二 基本语法

    基本语法 编号 类别 ORACLE MYSQL 注释 1 变量的声明方式不同 li_index NUMBER := 0 DECLARE li_index INTEGER DEFAULT 0 1. mysql 使用DECLARE定义局部变量.     定义变量语法为:  DECLARE var_name[,...] type [DEFAULT value] 要给变量提供一个默认值,需要包含一个DEFAULT子句.值可以被指定为一个表达式,不需要为一个常数.如果没有DEFAULT子句,初始值为NUL

  • Java经验点滴:类注释文档编写方法

    文章来源:csdn 作者:chensheng913 对于Java语言,最体贴的一项设计就是它并没有打算让人们为了写程序而写程序--人们也需要考虑程序的文档化问题.对于程序的文档化,最大的问题莫过于对文档的维护.若文档与代码分离,那么每次改变代码后都要改变文档,这无疑会变成相当麻烦的一件事情. 解决的方法看起来似乎很简单:将代码同文档"链接"起来.为达到这个目的,最简单的方法是将所有内容都置于同一个文件.然而,为使一切都整齐划一,还必须使用一种特殊的注释语法,以便标记出特殊的文档:另外还

  • XML轻松学习手册(四):XML语法

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

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

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

  • 详解python3类型注释annotations实用案例

    1.类型注解简介 Python是一种动态类型化的语言,不会强制使用类型提示,但为了更明确形参类型,自python3.5开始,PEP484为python引入了类型注解(type hints) 示例如下: 2.常见的数据类型 int,long,float: 整型,长整形,浮点型 bool,str: 布尔型,字符串类型 List, Tuple, Dict, Set: 列表,元组,字典, 集合 Iterable,Iterator: 可迭代类型,迭代器类型 Generator:生成器类型 Sequence

  • Groovy编程入门攻略

    当一个Java开发人员加入到Groovy的开发之旅的时候,他/她经常带着Java思想去思考,并逐步地学习Groovy,每次学习一个特性,这会让他慢慢变得更有创造性和写出更符合语言习惯的Groovy代码.这篇文章的目的是引导这些开发人员去学习基本的Groovy编程风格,学习新的操作技巧,新的语言特性,例如闭包等等.这篇文章并不会详细铺开描述,而是给读者一个入门的指引,并让读者在以后的深入学习打好基础.如果你喜欢这篇文章,可以贡献你的一份力量去丰富它. 无分号 C / C++ / C# / Java

随机推荐