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的屏幕截图：–
