如何用IDEA生成doc文档

JavaDoc可以将文档注释生成HTML文件,阅读起来很方便,像阅读Java的API一样。

文档注释规则为:

  • @author 作者名
  • @version 版本号
  • @since 最早使用的JDK版本
  • @param 说明一个方法的参数
  • @return 说明返回值类型

IDEA生成JavaDoc文档:

当我们写完类和方法的文档注释后需要生成doc时可以直接使用IDEA的Generate JavaDoc功能进行导出文档。

  1. 选择是整个项目还是模块还是单个文件
  2. 文档输出路径
  3. Locale 选择地区,这个决定了文档的语言,中文就是zh_CN
  4. 传入JavaDoc的参数-encoding UTF-8 -charset UTF-8

控制台的输出内容:

最后打开`index.html`就可以看到注释文档了
posted @ 2021-03-30 20:05  HeiDaotu  阅读(701)  评论(1编辑  收藏  举报