注释
在程序中,由于其基本组成都是代码,所以考虑到程序可维护性的特点,在编写代码时都要在每段代码上增加若干个说明文字,这些文字不需要被编译器编译,它们被称为Java的注释。对于注释,Java一共分为以下3种形式
- /:单行注释;
- /*...*/:多行注释;
- /**....*/:文档注释。
关于3种注释的选择
一般单行注释,注释少量代码或者说明内容,多行注释一般使用多行注释大量的代码或者说明内容,文档注释一般用于对类和方法进行功能说明 ,说明类的编写时间和作者以及方法作用参数和返回值。
单行注释
单行注释,就是在注释内容前面加双斜线(/),Java 编译器在进行程序编译时会 忽略 掉这部分信息。
java
public class Hello {
public static void main(String[] args) {
//此处为注释,编译代码时不编译
System.out.println("Hello World!");
}
}
public class Hello {
public static void main(String[] args) {
//此处为注释,编译代码时不编译
System.out.println("Hello World!");
}
}
多行注释
多行注释,就是在注释内容前面以单斜线加一个星形标记(/)开头,并在注释内容末尾以一个星形标记加单斜线(/) 结束。当注释内容超过一行时一般使用这种方法。
java
public class Hello {
public static void main(String[] args) {
/*
* 此处为多行
* 注释
*/
System.out.println("Hello World!");
}
}
public class Hello {
public static void main(String[] args) {
/*
* 此处为多行
* 注释
*/
System.out.println("Hello World!");
}
}
文档注释
文档注释,是以单斜线加两个星形标记(/**)开头,并以一个星形标记加单斜线(*/)结束。用这种方法注释的内容会被解释成程序的正式文档,并能包含进如 javadoc 工具生成的文档里,用以说明该程序的层次结构及其方法。
java
/**
* 你好
*
* @author OchiaMalu
* @date 2024/09/17
*/
public class Hello {
public static void main(String[] args) {
System.out.println("Hello World!");
}
}
/**
* 你好
*
* @author OchiaMalu
* @date 2024/09/17
*/
public class Hello {
public static void main(String[] args) {
System.out.println("Hello World!");
}
}
在文档注释中提供了许多类似于 @Author
的标记,例如:参数类型、返回值、方法说明等。而对于初学者而言,以上 3 种注释,重点先掌握单行注释和多行注释即可。