Idea生成JavaDoc文档

什么是JavaDoc

javadoc是Sun公司提供的一个技术 它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档

实现方式

  1. 命令行方式

javadoc -encoding UTF-8 -charset UTF-8 文件名.java

成功页面:
Idea生成JavaDoc文档
点击index.html就可以打开页面查看了 跟JDK官方文档差不多

  1. idea生成javaDoc文档
    • 点击菜单栏的Tools按钮 选择Generate JavaDoc 点击进入页面 如图
      Idea生成JavaDoc文档
    • whole project:整个项目
      File ...: 单个文件
      重点OutPut Directory: 文档存放目录 可以自定义
      -encoding UTF-8 -charset UTF-8 放到Other command line arguments中 点击OK 即可在目录看看到生成的文档
      Idea生成JavaDoc文档
上一篇:java基础1-变量+包机制+javadoc命令


下一篇:java学习prat2转义字符、注释与路径