idea 生成 javaDoc

Posted 2021-08-18 ttaolu

idea 生成 javaDoc

使用命令 Generate javaDoc
- 直接输入javadoc就可以了

---

1. Generate JavaDoc scope

   • 3个区域，一般选择第三项自定义，选择模块，生产模块的java文档

2. Include JDK and library sources in -sourcepath

   • 不清楚什么用处，欢迎补充
   • 使用 javadoc --help 查询到一条 解释为 ^{--source-path} 指定查找源文件的位置

3. Output directory

   • 输出目录 必填

4. Locale 本地化

   • 可以使用zh_CN

5. Other command Line arguments

   • 一般防止乱码问题都会加上这些参数，以及标题和jdk文档链接

     • -encoding UTF-8

     • -charset UTF-8

     • -windowtitle "浏览器窗口标题栏"

     • -link https://docs.oracle.com/javase/8/docs/api/index.html

       这个link参数是从Oracle官网的(2021-08-17)地址，依次点击如下即可到达

       https://www.oracle.com/index.html
       Products
       Java
       Download java
       找到版本比如 SE8
       Documentation
       Reference
       Java SE API Documentation

6. max heap size

• 猜测为运行javadoc时的 最大堆大小， 因为运行javadoc 也是一个java程序

---

关于 tags

• Standard Tags

---

_{*******************}End_{*******************}

---