单行注释
代码中以//
为开头的内容为单行注释。使用方式如下。
// 这是一段HelloWorld的Java代码
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
代码中,由//
开头的这一串代码,将不会参与编译过程。在其中可以编写任意内容,都不会影响代码的正常编译。
注释作用
注释最基本的作用就是,让编译器无视注释的内容。这种功能在开发过程中很常见。比如,在不确定某一部分代码的功能,但又不能轻易删除时,可以先注释代码,防止误删重要代码。
当然,注释并非仅用来让代码不参与编译。更重要的功能是给代码添加必要的解释。在代码量小、逻辑简单的时候,代码的解释并不重要。但是当代码量庞大到几天都写不完,或者复杂到一个人需要想好几个星期才能想到时。用人的语言对代码进行解释就会变得非常有必要。不仅方便别人看,也方便自己看。
多行注释
单行注释虽然灵活,但如果一段代码需要大量篇幅或者要分很多段来解释时,单行注释就会显得麻烦。相比之下,多行注释就会更有优势。
/*
这是一段代码
用它可以输出Hello World
*/
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World");
}
}
上面代码中,/*
和*/
之间的就是多行注释。
注意: 编译过程中,编译器会把从/*
到*/
之间的所有内容都当作注释来处理,包括/*
,也因此多行注释不能嵌套使用。
文档注释
文档注释时java特有的一种注释,使用方式和多行注释类似,也是可以写多行注释,但是相比于多行注释来说,文档注释还多了一个添加注解的功能。如下:
/**
这是一段代码
用它可以输出Hello World
@author zhangyue
@version 1.0
*/
public class HelloWorld {
/**
* 程序入口
* @param args 命令行参数
*/
public static void main(String[] args) {
System.out.println("Hello World");
}
}
代码中由/**
和*/
包围的内容就是文档注释(中间的*
只是为了好看),其中的@author
和@version
就是文档注释中的注解。当我们编译时编译器同样不会执行文档注释的内容。到目前位置文档注释和多行注释的功能还是相同的。但文档注释的功能不止于此,文档注释最重要的功能就是可以生成文档。
在源文件所在的目录执行命令javadoc -d mydoc -author -version HelloWorld.java
,就可以生成一个网络页面格式的文档。在浏览器中执行后可以得到如下页面。
命令中javadoc
就是java提供的解析文档注释的代码。-d
指生成的文件夹名称。-author
和-version
表示生成文档时要添加作者和版本号,如果编写文档注释时没有添加对应的注解,生成文档时不会报错,但也不会显示。