`

学习java的注释

    博客分类:
  • java
阅读更多
  注释也就是anotations是java1.5开始引入的,在jdk的文档中有这样的一段话是描述注解的,Annotation:Release 5.0 of the JDK introduced a metadata facility called annotations. Annotations provide data about a program that is not part of the program, such as naming the author of a piece of code or instructing the compiler to suppress specific errors. An annotation has no effect on how the code performs. Annotations use the form @annotation and may be applied to a program's declarations: its classes, fields, methods, and so on. The annotation appears first and often (by convention) on its own line, and may include optional arguments: JDK5,翻译一下就是jdk5.0引入了一个元数据功能叫做注解,注解提供的和程序有关的信息但是却不属于程序的一部分,这里估计就是不会被执行。如给一段代码命名作者,以及指定编译器不要注意特殊的错误,对于程序的执行不会有任何影响。注解的使用形式就是@anotation可以被置于一个程序的声明部分,类,类字段,以及方法。同时注解可以包含方法,呵呵翻译的不是很好啊,其实我读英文只能自己理解,翻译的话就不行了,不过分析总结一下,
   1:注解不会影响代码的运行,看上去好像就是写和不写运行结果,效率都一样。
   2:编译器能和注解交互,也就是说你可以影响编译的过程,呵呵,这点蛮强大的。
   3:实质就是提供关于注解对象的data,其中注解对象就是类啊,字段,以及方法。这个就很宽泛了,你想对这段代码,这个字段以及整个类赋予点什么特殊意义,就可以自己去实现一个注解,然后用你这个已经赋予特殊意义的注解去注解它就可以了。
   4:注解还可以带有参数。
    5:注解可以注解注解。
   谈了 注解的特点,就可以看看注解的用处,注解的特点决定了他以下 用途
1.编写文档,通过代码里标识的元数据生成文档;2.代码分析,通过代码里标识的元数据对代码进行分析;3.编译检查,通过代码里标识的元数据让编译器能实现基本的编译检查;4.使用Annotation部分代替XML文件来配置运行参数。
     最后我们讨论一下如何实现一个注解,其实实现一个注解和写一个类很相识 不过没写类那么复杂,同时jdk中已经有很多内置的注解,这些注解很多都是可以被编译器来识别,增加代码的健壮性,自已也可以实现一个注解。

   import java.lang.annotation.*;  
 
  @Target(ElementType.METHOD)  
  @Retention(RetentionPolicy.RUTIME)  
  public @interface Test {} 

上面就是一个注解了,怎么样很简单吧。解释一下,第一行是说这个注解使用来注解方法,第二行表示新定义的注解将在运行时起作用。  定义一个注解的时候,要用到一些元注解(Java内置的注解),如上面例子中的定义,@Target表明新定义的注解将用于方法定义上,@Retention表明新定义的注解将在运行时起作用。在注解中,一般都会包含一些元素以表示某些值,而没有元素的注解称为标记注解,如上面的@Test注解,下面定义一个新的注解,将包含一些元素,如:
import java.lang.annotation.*;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface GroupTODO {
  public enum Severity { CRITICAL, IMPORTANT, TRIVIAL, DOCUMENTATION };
  Severity severity()
        default Severity.IMPORTANT;
  String item();
  String assignedTo();
  String dateAssigned();
}
该注解中定义了两个元素id和description,其中description元素通过default指定了默认值。
这样我们就开发了两个注解,一个不带任何元素的标志注解,另一个带元素的注解,开发了注解之后,我们下一步就是用注解去注解我们的代码,这样的每一段被注解的代码编译后,注解信息就会带入到class中,我们就可以用代码分析器去分析编译后的class文件,提取注解信息。
分享到:
评论

相关推荐

    Java注释全解文档

    Java注释是编程过程中的重要组成部分,它们不仅有助于提高代码的可读性和可维护性,还能为其他开发者提供代码的功能解释和使用指南。本篇全解文档深入探讨了Java注释的各种类型及其在不同框架中的应用,如Hibernate...

    java注释模板

    实用的的java注释模板,可以让你们的开发注释得到统一。

    ajava注释说明

    在深入探讨Java注释的重要性与应用之前,我们先简要回顾一下给定文件的信息:标题为“ajava注释说明”,描述中强调了这是学习Java的必备文档,并鼓励大家积极学习Java。虽然部分文本似乎包含了乱码或非标准字符,但...

    java源码注释翻译

    Java源码注释翻译是一个重要的开发工具,尤其对于那些阅读英文源码或处理国际开源项目时,能够快速理解和学习代码的含义。这个项目的核心目标是批量处理Java源码文件,将其中的类注释自动翻译成中文,以帮助开发者...

    java反编译去除注释一建去除超级简单

    使用这样的工具,开发者或研究人员可以更容易地了解已有的Java类库或应用程序的工作原理,甚至可能用于学习和借鉴其他项目的实现。但要注意,未经许可的反编译和使用他人代码可能涉及到版权问题,因此在实际操作前,...

    Java代码、注释模版格式文件

    在编程领域,代码和注释的模板格式是至关重要的,特别是在Java这种面向对象的语言中。良好的代码风格和规范不仅能够提高代码的可读性,还能提升团队协作的效率,因为所有人都能按照统一的标准来编写代码。"Java代码...

    java经典去注释程序

    本项目名为“java经典去注释程序”,专门针对Java代码中的三种主要注释类型——行内注释(//)、块注释(/* */)和Javadoc注释(/** */)进行清除。 这个程序采用了枚举(enum)数据类型,这是Java中一种特殊的数据...

    Java注释全解文档.zip

    通过深入学习这些文档,开发者可以更好地理解和应用Java注释,以及在Spring、Hibernate和Struts2框架中如何有效地利用注解来简化配置,增强代码的可读性和可维护性。理解并熟练运用这些注解,将有助于提升开发项目的...

    JavaAPI部分练习代码全注释

    Java API是Java编程语言的核心库,包含了大量预定义的类...通过下载这个注释齐全的练习代码,你可以逐个学习和实践上述知识点,加深理解,并提升编程能力。记得理论结合实践,不断尝试和调试,才能更好地掌握Java API。

    Java简单记事本(有注释)

    Java Swing 是Java GUI(图形用户界面)库的一部分,它提供了丰富的组件和工具,用于构建桌面...通过学习和实践这些知识点,不仅可以理解Java GUI编程,还能掌握文件操作、事件处理和文本处理等多个领域的重要技能。

    JAVA写的扫雷 已经添加好了注释值得学习

    【标题】:“JAVA写的扫雷 已经添加好了注释值得学习” 【描述】:“JAVA写的扫雷 已经添加好了注释值得学习” 【标签】:“扫雷” “JAVA” 【文件列表】:扫雷 Java编程实现的扫雷游戏是一款经典的逻辑推理...

    带注释的Java聊天程序 课程设计

    在本课程设计中,我们将深入探讨一个基于Java的聊天程序,该程序带有详细的注释,旨在帮助学习者理解和掌握Java编程以及网络通信的基本原理。这个项目不仅提供了源代码,还通过注释为初学者提供了宝贵的指导,使其...

    java SE 飞机大战全注释

    通过学习《Java SE 飞机大战全注释》,开发者不仅可以掌握Java编程的基本技巧,还能理解游戏开发的基本流程和设计思路,为今后的项目开发打下坚实基础。此外,注释的详细程度有助于初学者更好地理解和学习源代码,...

    java代码注释规范文档

    #### 二、Java注释类型 ##### 2.1 单行注释 - **格式**:`// 注释内容` - **应用场景**: - 对单行代码进行简短说明。 - 当代码本身已足够清晰时,用于强调或补充信息。 **示例**: ```java int x = 5; // ...

    java 五子棋游戏源码 界面美观 详细注释 适合初学者

    Java五子棋游戏源码是为初学者设计的一个优秀学习资源,它可以帮助新手程序员了解如何在Java环境中构建一个简单的桌面游戏。在这个项目中,你将接触到基础的图形用户界面(GUI)编程、事件处理以及基本的游戏逻辑...

    编码规范 注释规范 代码风格 JAVA

    总结来说,理解和遵循编码规范、注释规范以及代码风格对于任何Java开发者都是至关重要的。华为的这些资源提供了一套完整的框架,旨在帮助开发团队产出高质量、易维护的代码。通过深入学习和应用这些规范,开发者不仅...

    Java编写的计算器附详细注释

    在编程世界中,Java是一种广泛使用的面向对象的编程语言,以其跨平台的特性深受开发者喜爱。本项目是一个基于Java编写...通过实践和理解这个程序,你将能够更好地掌握Java编程的基础,并为进一步的学习打下坚实的基础。

    java版象棋(有详细注释)

    7. **注释与可读性**:程序中的详细注释是学习和理解代码逻辑的重要工具。它们解释了类和方法的功能,变量的作用,以及复杂的算法步骤,有助于初学者快速理解和复用代码。 8. **测试与调试**:对于这样的项目,单元...

    java初学者完整代码+注释 17

    这个名为“java初学者完整代码+注释 17”的压缩包显然是一个针对Java初学者的学习资源,包含了第17天的学习内容。从描述中我们可以推断,这是一个系列教程,共21课,全都是中文讲解,非常适合对中国语言熟悉的初学者...

    Java程序设计案例包含注释

    本压缩包中的"Java程序设计案例包含注释"是学习Java编程的重要资源,它涵盖了Java的基础知识,包括基本语法、面向对象概念、字符串处理以及异常处理等方面。下面将对这些知识点进行详细的阐述。 1. **Java基本语法*...

Global site tag (gtag.js) - Google Analytics