Java注释

📌 相关文章

📜 Java注释

📅 最后修改于: 2020-09-25 06:32:24 🧑 作者: Mango

Java注释是编译器和解释器未执行的语句。注释可用于提供有关变量，方法，类或任何语句的信息或说明。它也可以用来隐藏程序代码。

Java注释的类型

Kava中有三种类型的注释。

单行注释
多行注释
文档注释

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);  
}  
}

输出：

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);  
}  
}

输出：

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类的说明。