如何用IDEA生成doc文档
JavaDoc可以将文档注释生成HTML文件,阅读起来很方便,像阅读Java的API一样。
文档注释规则为:
- @author 作者名
- @version 版本号
- @since 最早使用的JDK版本
- @param 说明一个方法的参数
- @return 说明返回值类型
IDEA生成JavaDoc文档:
当我们写完类和方法的文档注释后需要生成doc时可以直接使用IDEA的Generate JavaDoc
功能进行导出文档。
- 选择是整个项目还是模块还是单个文件
- 文档输出路径
- Locale 选择地区,这个决定了文档的语言,中文就是zh_CN
- 传入JavaDoc的参数
-encoding UTF-8 -charset UTF-8
控制台的输出内容:


【推荐】国内首个AI IDE,深度理解中文开发场景,立即下载体验Trae
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步