Java 注释

Java 注释是程序中不被编译器和解释器执行的语句。

为什么我们在代码中使用注释？

• 注释用于通过添加代码的详细信息来使程序更具可读性。
• 这使得代码易于维护，并且容易找到错误。
• 注释可用于提供有关 变量、方法、类 或任何语句的信息或解释。
• 它还可以用于在测试替代代码时阻止程序代码的执行。

Java 注释的类型

Java 中有三种类型的注释。

1. 单行注释
2. 多行注释
3. 文档注释

1) Java 单行注释

单行注释用于仅注释代码中的一行。它是注释语句最常用且最简单的方法。

单行注释以两个正斜杠 **(//)** 开头。// 前的任何文本都不会被 Java 执行。

语法

让我们在 Java 程序中使用单行注释。

CommentExample1.java

输出

10

2) Java 多行注释

多行注释用于注释多行代码。它可以用于解释复杂的代码片段，或者一次注释多行代码（因为在那里使用单行注释会很困难）。

多行注释放在 /* 和 */ 之间。/* 和 */ 之间的任何文本都不会被 Java 执行。

语法

让我们在 Java 程序中使用多行注释。

CommentExample2.java

输出

10

注意：通常 // 用于简短注释，/* */ 用于较长注释。

3) Java 文档注释

文档注释通常用于为项目或软件应用程序编写大型程序，因为它有助于创建文档 API。这些 API 需要用于参考，即代码中使用了哪些类、方法、参数等。

要创建文档 API，我们需要使用 javadoc 工具。文档注释放在 /** 和 */ 之间。

语法

javadoc 标签

文档注释中一些常用的标签

让我们在 Java 程序中使用 Javadoc 标签。

Calculate.java

使用 javac 工具进行编译

创建文档

使用 javadoc 工具创建文档 API

现在，将在当前目录（即 abcDemo）中为 Calculate 类创建 HTML 文件。打开 HTML 文件，我们可以看到通过文档注释提供的 Calculate 类的解释。

Java 注释是可执行的吗？

答：众所周知，Java 注释不会被编译器或解释器执行。但是，在编译器将代码进行词法转换之前，代码的内容会被编码成 ASCII 以便处理。

Test.java

输出

上面的代码会生成输出，因为编译器在进行词法转换之前会将 Unicode 字符 \u000d 解析为 换行符，因此代码会转换为如下所示：

Test.java

因此，Unicode 字符会将 print 语句移到下一行，并将其作为普通 Java 代码执行。