知识大全 Java注释的使用和定义
Posted 知
篇首语:峥嵘过去已经彪炳史册,璀璨当下正在不断延伸,光明未来需要踏实开拓。本文由小常识网(cha138.com)小编为大家整理,主要介绍了知识大全 Java注释的使用和定义相关的知识,希望对你有一定的参考价值。
Java元数据总结:Java注释的使用和定义 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!
元数据从metadata一词译来 就是 关于数据的数据 的意思 越来越的开源框架都提供了 元数据 支持了 其实也就是注释支持 今天系统学习一下Java注释(Java元数据) 本文内容不限于Javadoc的注释
什么是Java元数据 有什么作用?
元数据 就是 关于数据的数据 功能也有很多啦 你可能用过Javadoc的注释自动生成文档 这就是元数据功能的一种 总的来说 元数据可以用来创建文档 跟踪代码的依赖性 执行编译时格式检查 代替已有的配置文件(如Hibernate也提供了注释配置)
注释有 中基本类型
a 标记注释 没有变量 只有名称标识 例如 @annotation
b 单一值注释 在标记注释的基础上提供一段数据 如 @annotation( data )
c 完整注释 可以包括多个数据成员 每个数据成员由名称和值构成
@annotation(val = data val = data )
Java的 注释
Java中提供 个内置注释类型
a Override 只能用于方法(不能用于类 包声明或者其他构造)
作用 可以保证编译时候Override函数的声明正确性
用法 @Override
public void fun()
b Deprecated 同样只能作用与方法
作用 对不应再使用的方法进行注解
用法 @Deprecated public void fun //它们说这个注释跟函数要同一行
c SupressWarnings 可以注释一段代码
作用 关闭特定的警告信息 例如你在使用泛型的时候未指定类型
用法 @SupressWarnings(value= unchecked )
代码
Java中还提供了四种元注释 专门负责注释其他的注释
@Target 表示该注释可以用于什么地方 可用的ElementType参数包括
CONSTRUCTOR : 构造器的声明
FIELD : 域声明(包括enum实例)
LOCAL_VARIABLE : 局部变量声明
METHOD : 方法声明
PACKAGE : 包声明
PARAMETER : 参数声明
TYPE : 类 接口 (包括注解类型) 或enum声明
@Retention 表示需要在什么级别保存该注释信息 可选的RetentionPoicy参数包括
SOURCE : 注释将被编译器丢掉
CLASS : 注释在class文件中可用 但会被VM丢弃
RUNTIME : VM将在运行时也保留注释 因此可以通过反射机制读取注释的信息
@Documented 将注释包含在JavaDoc中
@Inheried 允许子类继承父类中的注释
在Java中定义自己的注释
Java语言支持一种新的类型——注释类型(annotation type) 跟普通类差不多 在类中以符号( @ )的形式注释其他 Java 代码
下面将通过一个简单的例子来实现(代码是Brett McLaughlin 的)
@interface 申明
i 简单的注释类型
package oreilly tiger ch ; /** * Marker annotation to indicate that a method or class * is still in progress */ public @interface InProgress
ii 使用定制的注释类型
@ oreilly tiger ch InProgress public void calculateInterest(float amout float rate) //Need to finish this method later
iii 添加成员
package oreilly tiger ch ; /** * Marker annotation to indicate that a method or class * is still in progress */ public @interface InProgress String value(); @ oreilly tiger ch InProgress @TODO( Figure out the amount of interest per month ) //或者@TODO(value= Figure out the amount of interest per month ) public void calculateInterest(float amount float rate)
iv 设置默认值
package oreilly tiger ch ; public @interface GroupTODO public enum Serverity CRITICAL IMPORTANT IRIVIAL DOCMENTATION ; Severity severity() default Severity IMPORTANT; String item (); String assignedTo(); String dateAssigned();
v 使用默认值
@ oreilly tiger ch InProgress @GroupTODO( item= Figure out the amount of interest per month assignedTo = Brett McLaughlin dateAssigned =
vi 改写默认值
@ oreilly tiger ch InProgress @GroupTODO severity = GroupTODO Severity DOCUMENTATION item = Need to explain how this rather unusal method works assignedTo = Jon Stevens dateAssigned =
相关参考
知识大全 JavaDoc,在 Java 的注释上做文章(上)
JavaDoc,在Java的注释上做文章(上) 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧! 对
知识大全 JavaDoc,在 Java 的注释上做文章(下)
JavaDoc,在Java的注释上做文章(下) 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧! 使
一Java文档 //注释一行 /**/注释若干行 /***/注释若干行并写入javadoc文档 通常这种注释的多行写法如下 /** * * */ javadocd文档存放目录au
知识大全 求助~~程序设计:输入一个正整数n,计算1到n的和,定义和调用求和函数,返回值为int型.
求助~~程序设计:输入一个正整数n,计算1到n的和,定义和调用求和函数,返回值为int型.#include<stdio.h>intsum(intn)inti,s=0;for(i=1;i&l
知识大全 C语言编程序1.输入一个实数,输出其绝对值。2.1!+2!+……+10!的和。要求将计算阶乘的操作定义成函数。3.输
C语言编程序1.输入一个实数,输出其绝对值。2.1!+2!+……+10!的和。要求将计算阶乘的操作定义成函数。3.输 以下文字资料是由(本站网www.cha138.co
Java自定义简单标签实例 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧!Java自定义简单标签可以
受控保险公司的定义所谓受控保险公司,据《跨国企业概念术语百科辞典》条目的注释,指的是“一家工商企业集团建立起来的保险公司,承保本公司集团全部或部分风险事宜。如果这家从事保险的子公司只限于某公司业务的范
如何在Java中如何定义一个常量 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧! 建议一个pack
在JAVA中定义类的结构 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧! 类的基本概念 Ja
Java中使用观察者模式实现自定义事件 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容,让我们赶快一起来看一下吧! MyEve