单行注释与多行注释
单行注释就是在代码里注释一行代码,将(//)放在需要注释的内容之前就可以了;
多行注释就是在代码里注释多行代码,使用/*
和*/
将代码中需要注释的类容包含起来,从/*
开始,*/
结束,下面代码为示例
class Hello{
/*
这里面的都是多行注释
你好Java
*/
public static void main(String args[]){
//这是单行注释。
System.out.println("Hello World");
System.out.println("这一行代码被注释了,将不会被编译、运行");
}
}
除此之外,增加注释也是调试程序的一个重要方法。如果觉得某段代码有问题,可以先把这段代码给注释掉,再次编译运行,如果正常运行,就说明这段注释掉的代码有问题,这样就缩小错误的范围,有利于排错;如果依然出现问题,就表示不是这段代码引起的,同样缩小了错误的范围。
文档注释
/**
* @Description: 这是文档注释
* @Author: QChen
* @DateTime: 2023-08-01
*/
class Hello{
public static void main(String args[]){
System.out.println("Hello World");
}
}
文档注释以"/**“开头,并以”*/"结束,可以通过 Javadoc 生成 API 帮助文档,Java 帮助文档主要用来说明类、成员变量和方法的功能。
@author
:制定Java程序的作者
@version
:Java代码的版本
@param
:方法的参数说明
@return
:方法的返回值说明
@throws
:抛出的异常