Java编程中的不同类型的注释

在Java中,为那些在运行时未由编译器和解释器执行的语句提供“注释”。我们可以使用注释来显示有关变量,类,方法以及任何操作/逻辑的信息。

它还用于隐藏程序中的特定行,语句或任何代码(您不希望执行这些代码,并希望保留以备将来参考)。

Java中的注释类型

Java有三种类型的注释,

  1. 单行注释

  2. 多行注释

  3. 文档注释

1.单行注释(//)

它由双斜杠(//)表示,仅用于注释单行,在这些字符(//)之后写入的文本将不会由编译器执行。

语法:

// this line will not be executed

2.多行注释(/*...*/)

它用于注释程序中的多行,因为有时我们需要比单行解释/编写更多行。因此,为此,我们需要使用多行注释。这些由/ *和* /表示

语法:

/*
Below code is used to create an employee class, this code is written by me 
on 27 Nov 2017. The code has been tested successfully.
Etc.
*/

3.文档注释(/**...*/)

在文档注释中,我们可以使用源代码的文档,基本上它用于描述特定的代码,功能描述等。

当我们使用文档注释时,它将成为'Javadoc'的一部分,并且将使用Javadoc工具。

Javadoc注释的结构

/**
    Paragraph description
    Tag labels
    @param  ...
    @return ...
    @author ...
    @throws ...
*/

带有文档注释的示例

/**
* This is a simple program to print Hello world!
*
* @author	Yamini Rawat
* @since	27/11/2017
* @reviewer	Alvin
*/
public class HelloWorld {

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

输出结果

Hello World!