包机制+JavaDoc生成文档

包机制

JavaDoc生成文档

作业：学会查找使用IDEA生成JavaDoc文档！

步骤 1：编写规范的代码注释

确保你的代码中包含符合 JavaDoc 规范的注释，例如：

步骤 2：打开 JavaDoc 生成工具

1. 点击顶部菜单栏的 Tools。
2. 选择 Generate JavaDoc...。

---

步骤 3：配置 JavaDoc 选项

在弹出的窗口中按需配置以下参数：

1. Scope（生成范围）：

   • 选择要生成文档的类/包/整个项目（如 Whole project 或自定义范围）。

2. Output directory（输出目录）：

   • 指定生成文档的保存路径（如 ./docs）。

3. Locale（语言）：

   • 输入 zh_CN 生成中文文档（若需要英文则留空）。

4. Other command line arguments（其他参数）：

   • 输入编码配置（避免中文乱码）：

-encoding UTF-8 -charset UTF-8 -windowtitle "文档标题" -author -version

---

步骤 4：生成文档

1. 点击 OK 开始生成。
2. 等待控制台提示生成完成。

---

步骤 5：查看生成的文档

1. 打开输出目录（如 ./docs）。
2. 双击 index.html 在浏览器中查看文档。

---

常见问题

• 中文乱码：确保编码参数包含 -encoding UTF-8 -charset UTF-8。
• 文档内容不全：检查代码注释是否符合 JavaDoc 规范（如 @param, @return 等标签）。
• 权限问题：确保输出目录可写入。