让别人和自己看懂自己的程序代码?一文掌握Java单行多行、文档注释以及注解(Annotation)超详细的理解使用,IDEA注释注解快捷键和模板,提高程序代码更有可读性

文章目录

    • 单行和多行注释
    • 文档注释(Java特有)
    • Annotation(注解)的理解
    • 常见的Annotation示例
    • IDEA注释注解快捷键及模板
    • 自定义 Annotation
    • JDK 中的元注解


单行和多行注释

注释的内容不参与编译,即编译以后的.class的字节码文件中不包含注释的内容。

作用:
①对程序进行解释说明,增强可读性。
②调试所写的代码。(将某代码注释来debug)

格式:
单行注释:以//开头
多行注释:注释内容用/**/一对包住

class HelloJava{/*多行注释:如下的main方法是程序的入口!main的格式是固定的!*/public static void main(String[] args){//单行注释:如下的语句表示输出到控制台。System.out.println("Hello Java !!!");}
}

文档注释(Java特有)

注释内容可以被JDK提供的工具javadoc解析,生成以网页文件形式展现的该程序的说明文档。

/**
文档注释:
@author Yeman
@version v1.0
*/public class HelloJava{/*多行注释:如下的main方法是程序的入口!main的格式是固定的!*//**文档注释:如下的main方法是程序的入口!*/	public static void main(String[] args){//单行注释:如下的语句表示输出到控制台。System.out.println("Hello Java!!!");}
}

Annotation(注解)的理解

从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持,也就是Annotation(注解)。

Annotation 其实就是代码里的特殊标记,这些标记可以在编译,类加载,运行时被读取,并执行相应的处理。通过使用 Annotation,程序员可以在不改变原有逻辑的情况下,在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

Annotation 可以像修饰符一样被使用,可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明,这些信息被保存在 Annotation 的 “name=value” 对中。

在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码和XML配置等。

未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解,注解是一种趋势,一定程度上可以说:框架 = 注解 + 反射 + 设计模式


常见的Annotation示例

示例一:生成文档相关的注解
@author 开发该类模块的作者,多个作者之间使用","分隔开
@version 该类模块的版本
@see 参考转向,也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明,如果没有参数就不能写
@return 对方法返回值的说明,如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写
其中
@param @return@exception 这三个标记都是只用于方法的
@param的格式要求:@param 形参名 形参类型 形参说明
@return 的格式要求:@return 返回值类型 返回值说明
@exception 的格式要求:@exception 异常类型 异常说明
@param@exception可以并列多个

/*** @Author: Yeman* @Date: 2021-09-10-11:13* @Description:*/
public class AnnotationTest {/*** 程序的主入口* @param args*/public static void main(String[] args) {System.out.println(getArea(3));}/*** 求圆的面积方法* @param radius double 圆的半径* @return double 圆的面积*/public static double getArea(double radius){return Math.PI * radius * radius;}
}

示例二:在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 重写父类中的方法,该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类、方法等)已过时
@SuppressWarnings: 抑制编译器警告

public class AnnotationTest{public static void main(String[] args) {@SuppressWarnings("unused")int a = 10;}@Deprecatedpublic void print(){System.out.println("过时的方法");}@Overridepublic String toString() {return "重写的toString方法()";}
}

示例三:跟踪代码依赖性,实现替代配置文件功能
Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。spring框架中关于“事务”的管理等。


IDEA注释注解快捷键及模板

关于IDEA中注释和注解快捷键及模板可以参见:《 IDEA注释注解快捷键及模板》


自定义 Annotation

定义新的 Annotation 类型使用 @interface 关键字。自定义注解自动继承了java.lang.annotation.Annotation接口

Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型,称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型及以上所有类型的数组。

可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字。

如果只有一个参数成员,建议使用参数名为value。
如果定义的注解含有配置参数,则使用时必须指定参数值,除非它有默认值。格式是“参数名 = 参数值”,若只有一个参数成员,且名称为value,可以省略“value=”。
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation。

自定义注解必须配上注解的信息处理流程才有意义,以下示例无意义,只是作为自定义的说明。

@interface MyAnnotation {String value() default "默认初始值";
}@MyAnnotation(value = "赋值")
public class AnnotationTest {public static void main(String[] args) {}
}

JDK 中的元注解

元注解:对注解进行解释说明的注解,修饰其他 Annotation 定义。

JDK5.0提供了4个标准的meta-annotation类型,分别是:
@Retention
@Target
@Documented
@Inherited

1.@Retention: 只能用于修饰 Annotation 定义, 用于指定该 Annotation 的生命周期,@Rentention 包含一个 RetentionPolicy 类型的成员变量,使用@Rentention 时必须为该 value 成员变量指定值:
RetentionPolicy.SOURCE:只在源文件中有效(即源文件保留),编译器则丢弃这种策略的注解;
RetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM 不会保留注解,这是默认值;
RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行 Java 程序时, JVM 会保留该注解,程序可以通过反射获取该注释。
在这里插入图片描述

@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation1{ }

2.@Target: 用于修饰 Annotation 定义,用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。
在这里插入图片描述

@Target({ElementType.CONSTRUCTOR,ElementType.METHOD,ElementType.TYPE})

若不使用,则默认自定义的Annotation可以用于所以程序元素。

3.@Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc工具提取成文档,默认情况下,javadoc是不包括注解的。
定义为Documented的注解必须设置Retention值为RUNTIME。

4.@Inherited: 被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation,则其子类将自动具有该注解。

5.@Repeatable:可重复注解,成员值为MyAnnotations. class。MyAnnotation的Target等其他元注解和Retention MyAnnotations都要相同。
在这里插入图片描述
6.JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:
TYPE_PARAMETERTYPE_USE。在Java 8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方。
ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)
ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中
在这里插入图片描述

在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/347620.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Java集合(1)--集合概述

Java 集合可分为 Collection 和 Map 两种体系 Collection接口:单列数据,定义了存取一组对象的方法的集合 ——List:元素有序、可重复的集合 ——Set:元素无序、不可重复的集合 Map接口:双列数据,保存具有…

win7下oracle10g安装,专门针对win7下oracle10g安装的详解

Window 7 下面安装Oracle 10g今在win7下安装oracle 10g client的时候遇到下面问题:在执行先决条件的时候,报目前只支持6.0的版本,修改oraparam.ini文件中的以下内容:[Certified Versions]#You can customise error message shown …

Java集合(2)--Collection接口方法

1、添加 add(Object obj)addAll(Collection coll)2、获取有效元素的个数 int size()在这里插入代码片3、清空集合 void clear()4、是否是空集合 boolean isEmpty()5、是否包含某个元素 boolean contains(Object obj):是通过元素的equals方法来判断是否是否同一个…

java核心面试_Java核心面试问题

java核心面试问:如果main方法被声明为私有该怎么办? 回答: 该程序可以正确编译,但在运行时会显示“ Main方法不公开”。 信息。 问:在Java中按引用传递和按值传递是什么意思? 回答: 通过引用…

oracle sql条件语句,谁能介绍下Oraclesql之条件语句?

一IF。。THENIFconditionTHENstatements1;statements2;。。。。ENDIF;二IF。。THEN。。。ELSEIFconditionTHENstatements1;statements2;。 。。。ELSEstatements1;statements2;。。。。ENDIF;三IF。。THEN。。ELSIFIFcondition1THENstatement1;ELSIFcondition2THENstatement2;…

Java集合(3)--Iterator迭代器

Iterator对象称为迭代器(设计模式的一种),主要用于遍历 Collection 集合中的元素。Collection接口继承了java.lang.Iterable接口,该接口有一个iterator()方法,那么所有实现了Collection接口的集合类都有一个iterator()方法,用以返…

oracle 中文脚本,ORACLE常用脚本

--创建表空间Create tablespace BRANCH datafile D:\tablespace\BRANCH.dbf size 500M autoextend on maxsize unlimited;--查询YS所拥有的表空间select distinct(tablespace_name) from dba_segments where ownerYS;--删除用户drop user ys cascade;--删除表空间及…

Java集合(4)--List接口及其实现类ArrayList、LinkedList和Vector

文章目录List接口概述List接口常用方法ArrayList实现类LinkedList实现类Vector实现类List接口概述 List集合类中元素有序、且可重复,集合中的每个元素都有其对应的顺序索引 List容器中的元素都对应一个整数型的序号记载其在容器中的位置,可以根据 序号…

java hadoop_单元测试Java Hadoop作业

java hadoop在我以前的文章中,我展示了如何设置一个完整的基于Maven的项目,以用Java创建Hadoop作业。 当然并没有完成,因为它缺少单元测试部分。 在这篇文章中,我将展示如何将MapReduce单元测试添加到我之前开始的项目中。 对于单…

软件连接oracle失败怎么办,【编程开发工具】navicat连接oracle失败怎么办

Navicat连接oracle数据库时连接失败,出现ORA-28547错误。原因:navicat Primium版本的OCi和本地数据库的OCI版本不一致。解决方法:1、把navicat Primium版本自带oci.dll替换本地Oracle安装路径里的oci.dll。我的本地navicat Primium版本自带oc…

Java集合(5)--Set接口及其实现类HashSet、LinkedHashSet和TreeSet

文章目录Set接口概述HashSet实现类LinkedHashSet实现类TreeSet实现类Set接口概述 1、Set接口是Collection的子接口,set接口没有定义额外的方法,使用的都是Collection接口中的方法。 2、Set 集合不允许包含相同的元素,如果试把两个相同的元素…

php设置超链接,怎么给一个PHP密码访问页面加超链接

该楼层疑似违规已被系统折叠 隐藏此楼查看此楼$password "1234"; // 这里是密码$p "";if(isset($_COOKIE["isview"]) and $_COOKIE["isview"] $password){$isview true;}else{if(isset($_POST["pwd"])){if($_POST["…

Java集合(6)--Map接口

文章目录Map接口概述Map结构的理解Map接口常用方法Map接口概述 Map与Collection并列存在,用于保存具有映射关系的数据:key-value Map中的 key 和 value 都可以是任何引用类型的数据 常用String类作为Map的“键”。key 和 value 之间存在单向一对一关系&#xff0…

php+js表单验证数字,.validate表单验证js

$("#signupForm").validate({rules: {name: {required: true},id:{required:true校验类型:}},messages: {name: {required: "请输入姓名"},id{required: 必填校验类型:}}})name可以填入div里的idrequired 设置必填校验类型取值描述requiredtrue|false必填字…

java低延迟_像Java这样的C ++具有低延迟

java低延迟总览 以前,我写过一篇有关Java之类的C的文章。 这是我以前遇到的术语。 但是,经过思考,我认为像Java这样的C 是一个更好的术语,因为您仍在使用OOP惯例(不是C惯例),但是您需要投入更多…

Java集合(7)--Map接口的实现类HashMap、LinkHashMap、TreeMap和Properties

文章目录HashMap类LinkedHashMap类TreeMap类Hashtable类Properties类HashMap类 1、HashMap类概述 HashMap是 Map 接口使用频率最高的实现类,允许使用null键和null值,与HashSet一样,不保证映射的顺序。 所有的key构成的集合是Set&#xff1a…

为什么SpringBoot如此受欢迎,以及如何有效地学习SpringBoot?

SpringBoot是最流行和使用最广泛的Java框架。 有时这种讨论“为什么SpringBoot如此受欢迎?” 来我和我的朋友/同事之间。 另外,我确实收到了许多人发来的电子邮件,询问“春天很大,如何快速学习?” 。 在这篇文章中&…

支持linux系统摄像头模块,在Linux操作系统上使用摄像头

我的公家笔记本的摄像头一直没啥用,偶尔用 vmware player 2.0模拟个 msn 用(其实到目前一次都没用过)。搞过安全对这东西严重不信任通常都不驱动,忽然想起重案6组那个警察兄弟说搞高科技的最怕高科技产品。linux 下一直没装,晚上闲着没啥事&a…

Java实现复数Complex的加减乘除运算、取模、求幅角角度

前些天发现了十分不错的人工智能学习网站,通俗易懂,风趣幽默,没有广告,分享给大家,大家可以自行看看。(点击跳转人工智能学习资料) /*** Author: Yeman* Date: 2021-09-23-9:03* Description:*/…

linux 域账户密码忘记,linux基础命令-用户域用户组管理

//与用户相关的配置文件:/etc/passwd: #用户的配置文件, 保存用户账户的基本信息/etc/shadow #用户影子口令文件一、用户帐号文件——passwd1.“/etc/passwd”文件是UNIX安全的关键文件之一。该文件用于用户登录时效验用户的登录名、加密的口令数据项、…