在编写程序时,为了使代码便于理解,通常会在写代码的时候加一些注释,注释在编译器编译时会自动忽略,不会将其编译到class字节码文件中去,说简单点,注释是给人看的啦。
一、单行注释
单行注释通常用于对程序中的某一行代码进行解释和说明,如下所示
//main函数是Java的主函数
int a = 10;// 定义一个整型变量a,并赋值为10
注意: 以上两行代码都有单行注释,第一行整行只有一个注释语句,第二行,int a = 10;是程序执行代码,会正常执行,后面部分是注释
多学一招: 注释的快捷键是 ctrl + / 快去试试
二、多行注释
多行注释就是对多行内容进行注释,注释部分同样会被编译器忽略,如下所示
/*
* Java的注释共三种方式:
* 1.单行注释
* 2.多行注释
* 3.文档注释
*/
注意: 多行注释以 /* 开头,以 */结尾。
三、文档注释
文档注释是对一段代码的概括性说明,一般用在类定义的开头,方法定义的开头
/**
* @param a
* @param b
* @return a+b
*/
public static int add(int a,int b) {
return a+b;
}
注意: 文档注释可以使用javadoc命令将提取出来生成帮助文档。