JavaDoc生成帮助文档

javaDoc是用来生成自己的帮助文档的

帮助文档格式及信息

参数信息：

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

//文档注释写法：
/**
*@author xxxx
*@version xxxx
* ......
*/

生成帮助文档

编写一个Doc.java文件，代码如下

package JavaDoc;
/**
* @author zhangsan
* @version 2020.3.4
* @since 18
*/
​
public class Doc {
/**
*
* @param args
* @throws Exception
*/
​
public static void main(String[] args) throws Exception{
​
}
}

在cmd窗口进入该文件的目标文件夹下，输入代码

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

随后会出现一大堆正在生成提示

再打开原文件夹，会发现多出来很多文件及文件夹

打开其中的index,html文件

就可以看到已生成的API文档