Java根据文档注释生成API说明文档

 

1. API注释

 

 

 

 

2. 通过IDEA生成API说明文档

(1) 路径“Tools”->“Generate JavaDoc…”

 

 

 标红处说明：

l 需要生成文档的文件路径

l 生成文档的存放路径

l 文档编码格式（Windows默认是GBK）

zh_CN

-encoding UTF-8 -charset UTF-8

 

(2) 点击“OK”，开始执行，生成文档。

 

 

 

(3) 文档打开页面如下：

 

 

 

3. 通过命令生产文档

javadoc -locale zh_CN -protected -splitindex -author -encoding UTF-8 -charset UTF-8 -d E:\workspace\myDoc\doc_dms_test