`

Java注释中的@deprecated

 
阅读更多

Java注释中的@deprecated与源代码中的@Deprecated

    用 @Deprecated注释的程序元素,不鼓励程序员使用这样的元素,通常是因为它很危险或存在更好的选择。在使用不被赞成的程序元素或在不被赞成的代码中执行重写时,编译器会发出警告。
   

    其次,请注意标题,这两个标记有大小写之分,一个是D,一个是d

源代码标记@Deprecated是在JDK1.5中作为内置的annotation引入的,用于表明类(class)、方法(method)、字段(field)已经不再推荐使用,并且在以后的JDK版本中可能将其删除,编译器在默认情况下检测到有此标记的时候会提示警告信息。

Java注释中的@deprecated用于在用Javadoc工具生成文档的时候,标注此类/接口、方法、字段已经被废止。

不过后者还有一个功能就是和源代码标记@Deprecated同样的功能,在JDK1.4版本之后,该功能被@Deprecated所取代。

   

java.lang.Deprectated是J2SE 5.0中标准的Annotation型态之一,它对编译器说明某个方法已经不建议使用,如果有人试图使用或重新定义该方法,必须提出警示讯息。

举个例子来说,您可能定义一个CustomObject类别,并在当中定义有getSomething()方法,而在一段时间之后,您不建议使用这个方法 了,并要将这个方法标示为deprectated,您可以这么作:

CustomObject.java
public class CustomObject {
	@Deprecated public String getSomething() {
		return "something";
	}
}

如果有人试图在继承这个类别后重新定义getSomething(),或是在程序中呼叫使用getSomething()方法,则进行编译时,就会出现这 个警讯:

Note: SubCustomObject.java uses or overrides a deprecated API.
Note: Recompile with -Xlint:deprecation for details.

想要知道详细的警讯内容的话,可以在编译时加上-Xline:deprecation自变量,例如:

>javac -Xlint:deprecation SubCustomObject.java
SubCustomObject.java:5: warning: [deprecation] getSomething() in CustomObject ha s been deprecated
object.getSomething();
^
1 warning

java.lang.Deprecated是个Marker annotation,简单的说就是用于标示,annotation名称本身即包括了要给工具程序的信息。

转自

http://lijinwei-123.i.sohu.com/blog/view/161053895.htm

 

分享到:
评论

相关推荐

    java 中@Deprecated 注解的实例详解

    @Deprecated 注解是 Java 中的一个标准 Annotation,用于标注类、字段和方法,以表明不鼓励程序员使用被注释的程序元素。使用 @Deprecated 注解可以让程序员意识到某些程序元素不再被建议使用,从而避免使用这些元素...

    Java注释全解文档

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

    javaAnnotation.pdf

    在Java中,注释主要有三种形式:单行注释、多行注释和文档注释。而Annotation是一种特殊的注释,它的语法以`@`符号开头,后跟注释的名字。例如,`@Override`和`@Deprecated`是Java内置的两种注释。对于带有参数的...

    史上最完整java注释教程

    Java注释是编程语言中的一种重要工具,用于提供元数据信息,这些信息可以在代码的生命周期中起到多种作用,包括但不限于帮助开发人员理解代码、辅助工具进行自动化处理以及提供运行时的元数据查询。在Java中,注释并...

    jdk注释讲解

    ### JDK注释详解:深入理解Java中的注解 在Java开发中,注解(Annotation)是一种重要的元数据机制,用于向编译器、工具或框架提供额外的信息,从而增强代码的功能性和可读性。本文将从JDK源注释出发,深入解析三种...

    java中元注解及实列

    Java中的注释是一种重要的编程工具,它允许程序员在代码中添加元数据,这些元数据能够指导Java编译器和运行时环境执行特定的操作。注释并非仅用于文档化代码,而是具有实际的功能性作用。从Java 5开始,引入了注解这...

    Kotlin基础学习之Deprecated与Suppress注解使用

    在 Java 方法中,如果需要废弃一个方法,只需要在方法钱加上 @Deprecated 即可,例如这样: @Deprecated public void test(){ } 但是如果在 Kotlin 代码中直接使用这个注释,就存在问题了: Deprecated 翻看源码...

    Java-文档注释例子

    在Java编程语言中,文档注释(Javadoc)是一种特殊类型的注释,它用于生成关于代码的自动文档。本文将深入探讨Java文档注释的概念、语法以及如何使用它来提高代码的可读性和维护性。 一、Java文档注释的作用 1. ...

    java-annotations,基于jvm的语言的注释。.zip

    Java注释在编程世界中扮演着重要的角色,尤其是在基于Java虚拟机(JVM)的语言中。Java注释是一种元数据,允许程序员向源代码中添加非执行信息,这些信息可以被编译器、IDE或其他工具读取并用于各种目的。在Java中,...

    Annotation注解的介绍和使用

    `@Deprecated`注释用于标记那些不推荐使用的方法或类,表明它们可能在未来版本中被移除或有更好的替代方案。使用了`@Deprecated`的代码元素在编译时会触发警告信息。 #### 三、自定义Annotation 开发者不仅可以...

    全面解析Java中的注解与注释

    Java中的注解(Annotation)和注释是编程中两种重要的文档和元数据工具,它们虽然在形式上相似,但有着本质的区别。注释是程序员为了提高代码可读性,为人类阅读者提供的一种解释性文字,而注解则是Java编译器和运行...

    Java注解详细说明

    Java注解,也称为标注(Annotations),是Java编程语言中的一个重要特性,用于向编译器、JVM或者其他的工具提供元数据。它们为程序提供了一种安全的方式,以声明信息,比如验证约束、记录元数据或者自动生成代码。...

    Java 文档注释

    Java 文档注释 Java 支持三种注释方式。前两种分别是 // 和 /* */,第三种被称作说明注释,它以 /** 开始,以 */结束。 说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出...

    105-Java核心编程14.docx

    在Java编程中,注解(Annotation)是一种强大的工具,自JDK 5.0引入以来,它极大地简化了代码管理和元数据的处理。注解不同于注释,它是代码的一部分,可以在编译、运行时被解析和执行特定的处理。本文将深入探讨...

    第-章-JAVA反射和注释优秀文档.pptx

    Java提供了预定义的注释类型,如@Override、@Deprecated,同时也允许用户自定义注释类型。注释处理器可以在编译期间读取注释并执行相应的处理。 类的初始化有特定的触发条件,包括创建类实例、访问或赋值静态变量、...

    java 通过反射获取类上注解,方法上注解,注解里的值及方法参数

    在Java编程中,注解(Annotation)是一种元数据,它提供了在代码中插入信息的方式,这些信息可以被编译器或运行时环境读取。反射(Reflection)是Java的一个强大特性,允许程序在运行时检查类、接口、字段和方法等...

Global site tag (gtag.js) - Google Analytics