在编写程序时,通常会为代码增加一些注释便于理解。Java注释就是用通俗易懂的语言对代码进行描述或解释,以达到快速、准确的理解代码的目的。注释可以是编程思路,也可以是功能描述或者程序的作用,总之就是对代码的进一步阐述。
Java注释只显现在Java源文件中,编译程序时编译器会忽略这些注释,不会将其编译到字节码文件中。Java中的注释有以下三种类型:
单行注释
单行注释用符号//表示,用于对程序中的某一行代码进行解释,一般用来注释局部变量,//后面是被注释的内容,不会被编译执行。具体实例如下:
int a=2; //定义一个整型变量
多行注释
多行注释以符号/*开头,以符号*/结尾,用于对程序中的多行代码进行解释。具体实例如下:
/* int b=3;
int c=4;
int d=5; */
文档注释
文档注释以符号/**开头,以符号*/结尾,文档注释是对一段代码概括性的解释说明,可以使用javadoc命令将文档注释提取出来,生成帮助文档。实例如下:
/**
*@ 作者
*@ version 1.0
*/
小扩展:jdk工具javadoc的作用是“生成Java文档”;javadoc是Java文档生成器,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。javadoc提供了一些标签用于文档注释,常用的标签如下表所示:
补充
在Java中,有的注释可以嵌套使用,有的不可以。
(1)多行注释中可以嵌套使用单行注释
/* int a=2; //定义一个整型的a
int b=3; */
(2)多行注释中不能嵌套使用多行注释