Java基础：生成JavaDoc文档的方法

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

参数信息
@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

一、用命令行生成JavaDoc
1.在IDEA选择选择要操作的类

2.在上方的导航栏里输出cmd 调出命令行窗口

可以在属性里调节字体大小和背景颜色等


3.调好后输入代码

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

4.再回去看文件

就会得到一个页面

用命令行生成JavaDoc文档的方法就完成了啦

二、用IDEA生成Doc文档
1.打开IDEA

2.

1. 选择要操作的文件
2. 输出的路径，记得是要在IDEA里创建的包
3. 可以决定文档的语言，中文的就输入zh_CN
4. 传入命令行的参数 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api（双引号内的生成的html页面标签的标题可自己定义）

3.点击确定后在IDEA左下角可以看到下图所示

4.在文件管理器里找到生成的html

生成的页面如下

小试牛刀