Java的三种注释和Java API文档

Java三种注释

Java注释是在Java代码中添加的文本，用于解释代码的功能、目的和工作原理

1.单行注释

以双斜杠//为开始，只能注释一行内容

// 这是单行注释

2.多行注释

写在/*与*/之间的注释，可以注释多行内容

/*
 * 这是多行注释
 * 可以注释多行内容
 */

3.文档注释

写在/**与*/之间的注释,一般用来注释类、方法、接口

/**
 * This is a class called Example
 * @author ZHONG
 * @version 1.0
 */
public class Example {
    /**
     * Input "Hello World !"
     * @param args This is a variable
     */
    public static void main(String[] args) {
        System.out.println("Hello World !");
    }
}

使用javadoc命令生成帮助文档

如果你有一个名为Example的java文件，要生成的帮助文档的名称为comment，要生成的标签为version和author，你需要在DOS命令下进入Example.java文件所在位置，并输入

javadoc -d comment -version -author Example.java

实际运行截图：

输入命令后，你会发现Example.java文件所在位置上多了一个名为comment的文件夹，点开文件夹，找到index.html，这个网页就是所生成的帮助文档

Java的API文档

应用程序编程接口API (Application Programming Interface)是Java预先定义的类或接口，通过使用Java API，开发人员可以避免重复编写常用的功能代码，提高开发效率。

Java的API文档用来告诉开发者如何使用Java预先定义的类或接口。

JDK17在线文档module indexhttps://docs.oracle.com/en/java/javase/17/docs/api/index.html