📜  Java注释

📅  最后修改于: 2020-09-26 14:14:59             🧑  作者: Mango

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

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

// declare and initialize two variables
int a =1;
int b = 3;

// print the output
System.out.println("This is output");

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

  • 声明并初始化两个变量
  • 打印输出

Java中的注释类型

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

  • 单行注释
  • 多行评论

单行注释

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

// "Hello, World!" program example
 
class Main {
    public static void main(String[] args) {        
    {
        // prints "Hello, World!"
        System.out.println("Hello, World!");
    }
}

输出

Hello, World!

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

  • “你好,世界!”程式范例
  • 打印“ Hello World!”

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


多行注释

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

/* This is an example of  multi-line comment.
 * The program prints "Hello, World!" to the standard output.
 */

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

输出

Hello, World!

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

/* This is an example of multi-line comment.
* The program prints "Hello, World!" to the standard output.
*/

这种类型的评论也称为传统评论 。在这种类型的注释中,Java编译器会忽略从/**/


正确使用注释

您应该始终考虑一件事,即注释不应该替代解释英文书写不好的代码的方法。您应该始终编写结构合理且自我解释的代码。然后,使用注释。

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

注意 :在大多数情况下,请始终使用注释来解释“ 为什么 “而不是“ 如何 “,这样您就很好了。