Java 菜鸟教程

Java 流程控制

Java 数组

Java 面向对象(I)

Java 面向对象(II)

Java 面向对象(III)

Java 异常处理

Java 列表(List)

Java Queue(队列)

Java Map集合

Java Set集合

Java 输入输出(I/O)

Java Reader/Writer

Java 其他主题

Java 注释

在本教程中,您将了解Java注释,为什么使用它们以及如何正确使用注释。

在计算机编程中,注释是程序的一部分,Java编译器完全忽略了注释。它们主要用于帮助程序员更容易理解代码。例如,

//声明并初始化两个变量
int a =1;
int b = 3;

//打印输出
System.out.println("This is output");

在这里,我们使用了以下注释:

  • 声明并初始化两个变量

  • 打印输出

Java中的注释类型

在Java中,有两种类型的注释:

  • 单行注释

  • 多行评论

单行注释

单行注释在同一行开始和结束。要编写单行注释,可以使用//符号。例如,

// "Hello, World!" 程序示例
 
class Main {
    public static void main(String[] args) {    	
    {
        // 打印输出 "Hello, World!"
        System.out.println("Hello, World!");
    }
}

输出

Hello, World!

在这里,我们使用了两个单行注释:

  • "Hello, World!" 程序示例

  • 打印输出 "Hello World!"

Java编译器会忽略从//行尾到行尾的所有内容。因此,它也称为行尾注释(单行注释)。

多行注释

当我们想写多行注释时,可以使用多行注释。要写多行注释,我们可以使用/*....*/符号。例如,

/* 这是多行注释的示例。
 * 该程序将打印“ Hello,World!” 到标准输出。
 */

class HelloWorld {
    public static void main(String[] args) {    	
    {	
        System.out.println("Hello, World!");
    }
}

输出

Hello, World!

在这里,我们使用了多行注释:

/* 这是多行注释的示例。
 * 该程序将打印“ Hello,World!” 到标准输出。
 */

这种类型的注释也称为传统注释。在这种类型的注释中,Java编译器将忽略从/*到的所有内容*/。

正确使用注释

您应该始终要知道一件事,即注释不应该成为代替解释不良代码的一种方式。您应该始终编写结构合理且能自我解释的代码。然后,再考虑使用注释。

有些人认为代码应该是自描述的,注释应该很少使用。但是,以我个人的观点,使用注释并没有错。我们可以使用注释来解释复杂的算法,正则表达式或需要在不同技术中选择一种技术来解决问题的方案。

注意:在大多数情况下,请始终使用注释来解释“ 为什么 ”而不是“ 如何做 ”。