Java 注释

java注释是不由编译器和解释器执行的语句。 注释可以用于提供关于变量，方法，类或任何语句的信息或解释。 它也可以用于隐藏特定时间的程序代码。

Java注释的类型

在Java中有3种类型的注释。

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

1）Java单行注释

单行注释仅用于注释一行。

语法：

//This is single line comment

相关实例：

public class CommentExample1 {
public static void main(String[] args) {
    int i=10;//Here, i is a variable
    System.out.println(i);
}
}

输出：

输出结果：
10

2）Java多行注释

多行注释用于注释多行代码。

语法：

/*
This 
is 
multi line 
comment
*/

相关实例：

public class CommentExample2 {
public static void main(String[] args) {
/* Let's declare and
 print variable in java. */
    int i=10;
    System.out.println(i);
}
}

输出结果：
10

3）Java文档注释

文档注释用于创建文档API。 要创建文档API，需要使用javadoc工具。

语法：

/**
This 
is 
documentation 
comment
*/

相关实例：

/** The Calculator class provides methods to get addition and subtraction of given 2 numbers.*/
public class Calculator {
/** The add() method returns addition of given numbers.*/
public static int add(int a, int b){return a+b;}
/** The sub() method returns subtraction of given numbers.*/
public static int sub(int a, int b){return a-b;}
}

通过javac工具编译：

javac Calculator.java

通过javadoc工具创建文档API：

javadoc Calculator.java

现在，将在当前目录中为您的Calculator类创建HTML文件。 打开HTML文件，并查看通过文档注释提供的Calculator类的说明。