JavaDoc生成帮助文档

原创于 2022-10-17 22:02:29 发布 · 248 阅读

CC 4.0 BY-SA版权

文章标签：

本文档介绍了如何利用JavaDoc工具生成帮助文档。JavaDoc通过注释获取作者、版本、参数等信息，然后自动生成API文档。只需在Java源代码中添加特定注释，如@author, @version等，然后在命令行运行javadoc命令即可生成文档。生成的文档包含了类、方法和参数的详细说明，方便其他开发者理解和使用你的代码。

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文档

在这里插入图片描述