常见的注解 [Java]

常见的注解(Annotation)

使用注解时要在前面加一个@符号,并把该Annotation当成一个修饰符来使用

• 注解就是用来修饰它支持的程序元素

这里我们要说三类常见的注解:

第一类: —> 生成文档相关的注解

@author

• 标明开发该类模块的作者,多个作者之间使用 , (逗号)隔开

@version

• 标明该类模块的版本

@see

参考转向,也就是相关主题

@param
对方法中参数的说明

• 如果无参就不能加此注解
• 格式: @param 形参名 形参类型 形参说明

@return

对方法的返回值的说明

• 如果方法的返回值是void,就不能加此注解
• 格式: @return 返回值类型 返回值说明

@exception

对方法可能抛出的异常进行说明

• 如果方法中没有显示的使用throws抛出异常就不能加此注解
• 格式: @exception 异常类型 异常说明

注意: @param,@return,@exception这三个标记 ( 没有配置参数 ( 成员变量 ) 的注解又称之为标记 ) 都只能用于方法

@param和@exception可以并列多个,因为一个方法的参数和抛出的异常都可能有多个

第二类: —> 在编译时进行格式检查的注解(JDK内置的三个基本注解)

@Override

限定修饰的方法必须为重写方法

• @Override只能用于方法

@Deprecated

用于表示所修饰的元素(类,方法)已经过时了

• 一般过时都是因为结构危险或者有更好的替代

@SuppressWarning
抑制编译器警告

• eclipse中左侧的灯泡+感叹号就是编译器警告,在IDEA中显示为暗色就是编译器警告

第三类 —> 组件和框架中涉及到的注解

@WebServlet

实现替代配置文件的功能

• 在Servlet3.0中提供了此注解

@Transactional
Spring框架中关于"事务"的管理