Java基础案例教程(第2版)
上QQ阅读APP看书,第一时间看更新

2.1.2 Java中的注释

在编写程序时,为了使代码易于理解,通常会在编写代码时为代码添加一些注释。注释是对程序的某个功能或者某行代码的解释说明,它只在Java源文件中有效,在编译程序时编译器会忽略这些注释信息,不会将其编译到class字节码文件中。

Java中的注释有以下3种类型。

1. 单行注释

单行注释用于对程序中的某一行代码进行解释,一般用来注释局部变量。单行注释用符号“//”表示,“//”后面为被注释的内容,具体示例如下:


int c = 10;      // 定义一个整型变量

2. 多行注释

多行注释就是注释的内容可以为多行,它以符号“/*”开头,以符号“*/”结尾。多行注释具体示例如下:


/*  int c = 10;
 int x = 5; */

3. 文档注释

文档注释是以“/**”开头,并在注释内容末尾以“*/”结束。文档注释是对一段代码概括性的解释说明,可以使用javadoc命令将文档注释提取出来生成帮助文档。文档注释具体示例如下:


/**
  name = "黑马程序员";
 */