Java支持三种注解:分为为单行注解、多行注解以及文档注解;下面将会对这三种
注解进行简要说明以及距离。
- 单行注解
单行注解以“//”标识,只能注解一行内容,如下所示。
public class Test01 {
public static void main(String[] args) {
// 我是单行注释
System.out.println("单行注释");
}
}
- 多行注释
注释内容包含在“/*”和“*/”之间,可以注释很多行内容,如下所示。
public class Test01 {
public static void main(String[] args) {
/*
* 我是多行注释
* 我是多行注释
* 我是多行注释
* 我是多行注释
*/
System.out.println("多行注释");
}
}
- 文档注释
包含在“/**”和“*/”之间,也能注释多行内容,一般用在类、方法和变量上面,用来描述其作用。注释后,鼠标放在类和变量上面会自动显示出我们注释的内容,如下所示。
/**
* 我是文档注释
*/
public class Test01 {
public static void main(String[] args) {
System.out.println("文档注释");
}
}
文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档,并输出到 HTML 文件中,方便记录程序信息。下篇文章中,将通过实际案例去带领大家如何通过Javadoc 命令和文档注解去实现JAVA文档的输出。