Java注释

作用

Java中的注释可以帮助程序员更好的理解代码是做什么用的,以至于过了很久后再去看这段代码都不知道做什么用的了,java中的注释有很多 种,比如单行注释,多行注释和doc注释,而doc注释又分为类注释和方法注释

单行注释

单行注释一般是写在代码的上面,用来说明这一行代码的作用,当然也可以用来注释没有用的代码

语法:以//开头

idea默认快捷键:ctrl+/,再次按则是取消注释

示例:

//定义变量i的值为0
int i=0;

多行注释

多行注释一般是针对单行注释一行写不下时才使用,也可以用来批量注释代码

语法:以/*开头 */结尾

idea默认快捷键:ctrl+shift+/,再次按则是取消注释

示例:

/*public static void main(String []args){
    //定义变量i的值为0
    int i=0;
}*/

doc注释

doc注释主要作用于pojo类的属性、方法和类

idea快捷键:输入/** 然后按回车键会自动生成带参数和返回值的注释模板

语法如下

/**
 * 
 */

下面将分别讲解这三种作用地点

pojo类的属性

/**
 * 角色名称
 */
private String roleName;

在使用了roleName的地方我们可以将鼠标移上去然后按住ctrl+Q就可以看到注释,如下图

方法

/**
 * 测试
 * @param name 名字
 * @return 空值
 */
public String test(String name){
    return "";
}

在调用处同样按ctrl+q可以显示doc注释,如下图

这里使用到了@param和@return,下面说明一下可以使用的常用参数

参数	作用
@param	参数说明
@return	返回内容
@throws	抛出的异常
@deprecated	提示该方法已废弃,建议不要使用
@auther	作者
@date	创建时间
@description	方法描述

类

/**
 * 测试类
 *
 * @author master
 * @date 2021-07-31
 */

可以在创建类的时候自动生成模板