注释
分类
- 单行注释
单行注释就是在注释内容前面加双斜线(//),Java编译器会忽略这部分信息。如下所示:
int num; // 定义一个整数
- 多行注释
在注释内容的前面以单斜杠加一个星形标记(/*)开头,并在注释内容末尾以一个星形标记加单斜杠结束。当注释内容超过一行时一般用这种方法。如下所示:
/* int c = 10;
String s = "hello"; */
不过,一般为了美观,会像下面这样写:
/*
1. int c = 10;
2. String s = "hello";
*/
- 文档注释
以单斜线加两个星形(/**)开头,并以一个星形标记(*)加一个单斜线(/)结束。用这种方法注释的内容会被解释成程序的正式文档,并能包含进如javadoc之类的工具生成的文档里,用以说明程序的层次结构及其方法。如下所示:
package hello;
/**
* @author XY
* @ClassName Hello
* @Description 这是Java的一个简单范例
* @date 2018/12/1 22:37
*/
public class Hello {
public static void main(String[] args) {
System.out.println("Hello world!");
}
}
通常,在程序的开头加入作者、时间、版本、要实现的功能等内容注释,方便后来的维护以及程序员的交流。
需要注意的是,注释文档第2~5行前面的星号并不是必须的,只是为了美观才加入的。