首页 > 编程笔记

Java注释(3种)

所谓注释,就是对代码的说明和解释,是给人看的,并不会被编译器按照 Java 语法处理,因此是可以写汉语可以随意写的,但是需要格式约束。

Java 支持以下三种形式的注释。

1. 单行注释

单行注释以//开头,表示这一行全部为注释。

换句话说,单行注释只能注释一行内容;要想注释多行,必须每一行都以//开头。

Java 单行注释代码:
//第一个Java程序
public class Main{
public static void main(String[] args) {
        System.out.println("http://c.biancheng.net");
    }
}

2. 多行注释(段注释)

顾名思义,多行注释用来注释多行文本,因此它也叫段注释。

多行注释以/*开头,以*/结束,在这之间的都会当做注释看待,适合内容较多、多行显示的注释信息,例如:
/*
第一个Java程序
大部分Java初学者都从这里开始
这段代码输出一段简单的文本内容
*/
public class Main{
public static void main(String[] args) {
        System.out.println("http://c.biancheng.net");
    }
}

3. 文档注释

Java 文档注释以/**打头,以*/结束。

不同于多行注释,文档注释会将/***/之间的内容归档与 javadoc 中,在生成 HTML 报告时被识别显示出来,用于记录程序信息。

在类、方法、模块的开头往往使用文档注释,这其中还支持用@标识出各种标签。

文档注释举例:
/**
Author: YanChangSheng
Data: 2023/7/14
*/
public class Main{
public static void main(String[] args) {
        System.out.println("http://c.biancheng.net");
    }
}

推荐阅读