Java 程序中的注释
注释就是对代码进行解释说明的文字,一般的程序设计语言都提供了程序注释,通过注释可以让别人或者自己读懂编写的程序。
==程序中的注释不是程序的语句部分,它可以放在任何地方,系统在编译时会忽略掉==
举个例子:我今天写了一个程序,程序里面没有写注释,这个时候自己还可以看懂,然后过了一个月再回来看自己写的程序,就发现只有天知道这个程序到底写了些什么了。
写注释还是一个很重要的习惯,Java 提供了两种注释方式:==程序注释和程序文档注释==
一、程序注释
1、单行注释
单行注释以双斜杠( // )开始
以 “ // ” 开始后面跟注释的文字;这种注释方式可以独占一行,也可以跟在程序语句的后面,例:
public class test{
//下面这句是 main 方法,表示程序的入口(这个就是单独占一行的注释)
public static void mian(String[] args)
{
System.out.println("Hello World!!!"); //这句是 Java 程序的输出语句,打印输出小括号里面的内容(这个就是跟着程序语句后面的注释)
}
}
2、多行注释
多行注释以 “ / ” 开始,以 “ / ” 结束
当需要多行注释时,一般使用 “ / ······ / ” 格式作为注释,中间的 “ ······ ” 为注释的内容,例:
public class test{
public static void main(String[] args)
{
/*
上面这句是 main 方法,表示程序的入口
下面这句是 Java 程序的输出语句,打印输出小括号里面的内容
*/
System.out.println("Hello World!!!");
}
}
二、程序文档注释
程序文档注释是一种特有的注释方式,它规定了一下专门的标记,其目的是自动生成独立的程序文档。
程序注释通常用于注释类、接口、变量和方法,例:
/**
* 该类中包含了一些操作数据库常用的基本方法
* 在数据表中进行添加、修改、删除、查询操作
* 其他数据信息
* @author Zhang San
* @version 3.1,30/07/2022
* @since JDK1.8
*/
在上面的程序文档注释中,除了说明文字之外,还有一些有 @ 字符开头的专门标记,
@author 用于说明本程序代码的作者
@version 用于说明程序代码的版本以及发布时间
@since 用于说明开发程序代码的软件环境
此外,文档中还可以包含 HTML 标注,在Java 中 JDK 提供了文档生成工具 javadoc.exe 能够识别一些特殊的标记和标注,并根据这些注释生成超文本 Web 页面形式的文档
三、小结
在实际的开发过程中,很多人会觉得注释没有用,但实际上事实恰恰相反,一个好的注释习惯可以让你在学习过程中记住的东西更多,在回过头在复习的时候也会更加的方便。就算是到了工作里面,在公司交接时,通过代码注释也可以让交接工作变得更加的轻松。