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

简介: 让别人和自己看懂自己的程序代码?一文掌握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;
  }
  @Deprecated
  public void print(){
  System.out.println("过时的方法");
  }
  @Override
  public 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 会保留该注解,程序可以通过反射获取该注释。


7c993657d758459c925ed5ebcde9c128.png


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


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


19127f96644b49a9895c82c40e69387b.png


@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都要相同。


7ed9828de2f44dd2979ccde48b57a3e4.png


6.JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:

TYPE_PARAMETER,TYPE_USE。在Java 8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方。

ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)

ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中


3b0463a23e6d4bc0bfd5dc2427bf3dad.png7fa9e903ec44493bb401cd90dc4ecddc.png



相关文章
|
21天前
|
Java Maven
Class path contains multiple SLF4J bindings,后来找到的解决思路是idea2019.3必须用java11和idea2019.3版本,必须用applicatio
Class path contains multiple SLF4J bindings,后来找到的解决思路是idea2019.3必须用java11和idea2019.3版本,必须用applicatio
|
11天前
|
Java
idea启动java服务报错OutOfMemoryError: GC overhead limit exceeded解决方法
idea启动java服务报错OutOfMemoryError: GC overhead limit exceeded解决方法
|
13天前
|
存储 Oracle Java
Java面试题:描述如何使用Eclipse或IntelliJ IDEA进行Java开发?
Java面试题:描述如何使用Eclipse或IntelliJ IDEA进行Java开发?
17 0
idea快捷键:全局搜索文件,代码,接口,ctrl+shift+f无效?也可以点击Edit 点击Find Replace in path
idea快捷键:全局搜索文件,代码,接口,ctrl+shift+f无效?也可以点击Edit 点击Find Replace in path
|
19天前
|
Java Maven
第一次导入项目,从gitee拉取的代码无法拉取怎么解决,idea如何导入项目,如何跑拉取的项目,如何使用Maven导入项目,如何回到idea首页,如何导入第一次的项目,拉取的代码出现了橘黄色图标,图片
第一次导入项目,从gitee拉取的代码无法拉取怎么解决,idea如何导入项目,如何跑拉取的项目,如何使用Maven导入项目,如何回到idea首页,如何导入第一次的项目,拉取的代码出现了橘黄色图标,图片
idea如何历史回溯,如何返回之前写的代码
idea如何历史回溯,如何返回之前写的代码
|
1月前
|
缓存 IDE Java
Idea里开发遇到所有项目的所有代码爆红的问题与解决
在Idea中,用户意外遇到所有项目代码显示错误但能正常运行的问题。尝试清理缓存、更改编码和切换JDK等方法无效。最终解决方案是检查并移除Maven的.class文件忽略设置:进入File--Editor--File Types,确保Ignore files and folders列表中没有配置为忽略*.class文件。移除后,IDE重新索引,红色错误提示消失。
|
1月前
|
IDE Java 项目管理
Java入门——Intellij IDEA简介、使用IDEA开发程序、IDEA常用快捷键、IDEA其他操作
Java入门——Intellij IDEA简介、使用IDEA开发程序、IDEA常用快捷键、IDEA其他操作
29 3
|
26天前
|
移动开发 小程序 关系型数据库
java+ IDEA+ Uniapp+ mysql医院3D智能导诊系统源码
这是一个基于Java、IDEA、Uniapp和MySQL的医院3D智能导诊系统,采用Springboot后端框架和Redis、Mybatis Plus、RocketMQ等技术。系统通过对话式交互,精准推荐就诊科室,解决患者挂号困扰。它还具备智能预问诊功能,提升诊疗效率和准确性,确保医生能快速了解患者详情。此系统还支持小程序和H5,方便患者使用。
26 0
|
29天前
|
Java 开发者
java开发者工具IDEA自定义设置主题/字体/字号大小
java开发者工具IDEA自定义设置主题/字体/字号大小
21 0