JavaDoc 工具是Java编程语言中的文档生成工具，用于生成 HTML 格式的标准文档。它生成 API 文档。它解析一组描述类、方法、构造函数和字段的源文件中的声明和文档。
在使用 JavaDoc 工具之前，您必须包含 JavaDoc 注释 /**………………..*/ 提供有关类、方法和构造函数等的信息。要为任何Java文件创建良好且易于理解的文档 API，您必须编写为每个类、方法、构造函数提供更好的注释。
JavaDoc 注释与普通注释不同，因为注释开头有一个额外的星号。它也可能包含HTML 标签。
// Single-Line Comment
/*
* Multiple-Line comment
*/
/**
* JavaDoc comment
*/通过编写大量注释，它不会影响Java程序的性能，因为所有注释都在编译时被删除。
JavaDoc 格式： –
它有两部分： – 描述，后跟块标记。
一些集成开发环境 (IDE) 会自动生成 JavaDoc 文件，如 NetBeans、IntelliJ IDEA、Eclipse 等。
JavaDoc 的生成： –
要创建 JavaDoc，您不需要编译Java文件。要创建Java文档 API，您需要编写 Javadoc，后跟文件名。
javadoc file_name or javadoc package_name成功执行上述命令后，会创建一些HTML文件，打开名为index的文件可以看到所有类的信息。
JavaDoc 标签
| Tag | Parameter | Description |
|---|---|---|
| @author | author_name | Describes an author |
| @param | description | provide information about method parameter or the input it takes |
| @see | reference | generate a link to other element of the document |
| @version | version-name | provide version of the class, interface or enum. |
| @return | description | provide the return value |
在 Eclipse 中生成 JavaDoc： –
- 从项目菜单中选择“生成 JavaDoc”选项，将出现一个向导。
- 在您的计算机上指定 JavaDoc 文件的位置，默认情况下它将在 C 驱动器中。
- 选择项目，然后选择要为其创建 JavaDoc 文件的包。
- 在右侧之后，选择要为其生成 JavaDoc 的类，默认情况下将选择所有类。
- 然后，您还可以通过选择可见性来指定将为哪些类生成 JavaDoc。
- 选择将放置生成的 JavaDoc 的目标位置。
- 然后单击下一步或完成。
如果您在下一个窗口中选择下一步，您可以选择文档标题和其他基本选项。
示例 1： –
Java
package exa;
import java.util.Scanner;
/**
*
* @author Yash
*/
public class Example {
/**
* This is a program for adding two numbers in java.
* @param args
*/
public static void main(String[] args)
{
/**
* This is the main method
* which is very important for
* execution for a java program.
*/
int x, y;
Scanner sc = new Scanner(System.in);
/**
* Declared two variables x and y.
* And taking input from the user
* by using Scanner class.
*
*/
x = sc.nextInt();
y = sc.nextInt();
/**
* Storing the result in variable sum
* which is of the integer type.
*/
int sum = x + y;
/**
* Using standard output stream
* for giving the output.
* @return null
*/
System.out.println("Sum is: " + sum);
}
}为上述类生成文档
javadoc exajavadoc 的截图： –
