Java基础：JavaDoc生成文档

Jdk帮助文档

https://docs.oracle.com/javase/8/docs/api/
javadoc命令是用来生成自己的API文档的。

输入/**然后回车

加在类上面就是类的注解，加在方法上面就是方法的注解。

• javac = 编译
• java = 运行
• javadoc = 生成文档
  
  此为生成的文档。
  

用IDEA生成javadoc文档

IDEA生成JavaDoc
在IntelliJ IDEA中生成JavaDoc文档非常简单，以下是具体步骤和示例。

/**
* 示例类
*/
public class Example {
/**
* 打印消息
* @param message 消息内容
*/
public void printMessage(String message) {
System.out.println(message);
}
}

生成步骤

1. 打开工具菜单：在IDEA顶部菜单栏选择Tools。
2. 选择生成JavaDoc：点击Generate JavaDoc选项。
3. 配置生成范围：选择需要生成JavaDoc的范围，例如单个文件、整个模块或项目。
4. 设置输出目录：建议新建一个文件夹用于存放生成的文档，保持整洁。
5. 语言区域设置：根据需要选择语言，例如简体中文为zh_CN。
6. 添加命令行参数：如需支持中文，添加-encoding UTF-8 -charset UTF-8。
7. 点击确定：完成设置后点击OK，IDEA会自动生成JavaDoc。

查看结果
生成完成后，打开指定的输出目录，双击index.html即可查看生成的JavaDoc文档。

注意事项
确保代码中已添加完整的注释，否则生成的文档可能不完整。
如果项目较大，建议分模块生成以提高效率。

补充：
生成 Javadoc 可以自动提取代码注释，生成规范的网页格式 API 说明文档，方便代码阅读、项目维护与他人调用，保证代码与文档同步统一。