Java--JavaDoc生成文档

javadoc命令是用来生成自己API文档的

文档注释：

/**
 * @author ZZQ
 * @version 1.0
 * @since 1.8
 */

参数信息

@author 作者名

@version 版本号

@since 指明需要最早使用的jdk版本

@param 参数名

@return 返回值情况

@throws 异常抛出情况

命令行生成JavaDoc文档

1. 在cmd中进入.java文件的地址

2. javadoc 参数 Java文件

例如：javadoc -encoding UTF-8 -charset UTF-8 Doc.java

其中参数是为了编译中文

IDEA生成JavaDoc文档

1. 工具栏中点击Tools，打开选项Generate JavaDoc

2. 配置对应参数

其中第一步选择生成JavaDoc文档的对应文件

第二步选择存放JavaDoc文档的文件夹

第三步选择文档语言，简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww

第四步设置编码，为了使显示的中文不出现乱码

-encoding UTF-8 -charset UTF-8

设置完即可生成doc文档