Java 注释

注释是对程序语言的说明，有助于开发者和用户之间的交流，方便理解程序。注释不是编程语句，因此被编译器忽略。

1 Java注释的分类

Java注释有三种类型：

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

2 Java单行注释

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

2.1 Java单行注释语法

//这是单行注释

2.2 Java单行注释的示例

package com.yiidian;

public class Demo {

    public static void main(String[] args) {
        int i=10;//i是一个变量
        System.out.println(i);
    }
}

输出结果为：

10

3 Java多行注释

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

3.1 Java多行注释语法

/* 
  这
  是
  多行注释
*/  

3.2 Java多行注释的示例

package com.yiidian;

public class Demo {

    public static void main(String[] args) {
        /* 
          声明了一个变量i 
        */
        int i=10;
        System.out.println(i);
    }
}

输出结果为：

10

4 Java文档注释

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

4.1 Java文档注释语法

/** 
  这
  是  
  文档注释
*/  

4.2 Java文档注释的示例

package com.yiidian;

/** 
 * 运算工具类，提供常用的运算方法
 *
 * */
public class Calculator {
    /** 
     * add()方法，用于相加运算
     * */
    public static int add(int a, int b){
        return a+b;
    }
    
    /** 
     * sub()方法，用于减法运算
     * */
    public static int sub(int a, int b){
        return a-b;
    }
}

通过javac工具进行编译：

javac Calculator.java

通过javadoc工具创建文档API：

javadoc Calculator.java

执行完以上命令后，会在执行目录下产生Calculator类创建HTML文件。打开HTML文件，就可以看到通过文档注释提供的Calculator类的说明。