Java单行、多行和文档注释!Java入门基础

463 阅读2分钟

在编写Java的过程中,我们需要对一些程序进行注释。除了方便自己阅读之外,我们还需要为他人更好地理解我们的程序。因此,我们需要对一些程序进行注释,这些注释可以是编程思想,也可以是程序的作用,可以说是Java入门基础了!

想知道更多Java基础内容可以参考以下视频 ↓ ↓ ↓

Java300集零基础适合初学者视频,Java入门必学,Java基础

注释不是编程语句,因此被编译器忽略。总之,这对我们自己和其他人来说都是很方便的,希望大家都可以养成随手注释的好习惯,这样就算过了很久也可以根据注释内容来区分内容!

对于Java注释我们主要了解

1, // 注释一行

以双斜杠“//”标识,只能注释一行内容,用在注释信息内容少的地方。打开 Eclipse,在 Java 代码中使用单行注释

image.png

2, /* ...... */ 注释若干行

包含在“/”和“/”之间,能注释很多行的内容。为了可读性比较好,一般首尾行不写注释信息,这样整齐美观!

注意: 多行注释可以嵌套单行注释,但是不能嵌套多行注释和文档注释。

image.png

3, /**……*/文档注释

包含在“/**”和“*/”之间,也能注释多行内容,一般用在类、方法和变量上面,用来描述其作用,注释后,鼠标放在类和变量上面会自动显示出我们注释的内容。

注意: 文档注释能嵌套单行注释,不能嵌套多行注释和文档注释,一般首行和尾行也不写注释信息。

image.png

文档注释可以通过 Javadoc 命令把文档注释中的内容生成文档,并输出到 HTML 文件中,方便记录程序信息,非常方便!

注释的作用主要是提高Java源程序代码的可读性;使得Java程序条理清晰,易于区分代码行与注释行。另外通常在程序开头加入作者,时间,版本,要实现的功能等内容注释,方便后来的维护以及程序员的交流。

微信截图_20210926175921.png

总结: 在 Java 中,一行注释以双斜杠“//”标识;多行注释包含在“/”和“/”之间;文档注释包含在“/**”和“/”之间。 * 当编译器执行到“//”时,就会忽略该行“//”之后的所有文本;当执行到“/ * ”时,会扫描下一个“* /”并忽略“ / * ”和“ * / ”之间的任何文本;当执行到“/* ”时,也会扫描下一个“/”并忽略“/* * ”和“* /”之间的任何文本内容!

今天主要就给大家说这些了,有其他意见和想法的朋友可以留言讨论哦,我们一起学习,一起进步!