1、Java 中的注释详解
概括:注释是增加一些说明,在编译后,注释会被抹掉,不起任何租用,只在书写代码的时候,对代码进行的一个说明
不管是那种编程语言, 代码的注释都是必备的语法功能, 并且一个好的程序的指标之一,就是能有一个好的注释。 那 Java 中的注释是怎么定义的呢? 我们来说说。
1)Java 中 3 种注释类型
-
单行注释
-
多行注释
-
文档注释
2)单行注释
单行注释: Java 中最简单的注释方法, 使用两个反斜杠 // 就可以了。注释的内容从 // 开始。
举个例子:
单行注释不仅可以注释备注信息, 并且也可以注释代码内容。
单行注释的推荐写法就是写在代码的上一行中。
2、多行注释
多行注释:Java 中使用以 /* 开始, 以 */ 结束的注释方式。
举个例子:
匹配规则就是 /* 与之对应的最近的 */ 结束符。
除了单行注释和多行注释,还有一种是文档注释。
3、文档注释
编写任何的代码,都少不了编写程序的文档, 怎么高效的编写文档内容,并且文档的内容能够随着版本的更新进行更新。Java 语言中有一种注释规则, 就是文档注释类型。对于文档注释的内容,是可以通过 Java 内置命令行工具 javadoc 生成对应的文档内容的。并且Java 的 API 也是基于这种机制生成的文档。
使用文档注释的方式 以 /** 开头 */ 结尾。包含在这之内的内容就是文档注释的内容。 而且针对文档注释有一系列的标记。该注释一般会放在 类、方法、变量、常量上。
演示案例:
4、idea 注释的配置见:
idea下载及安装-CSDN博客