光辉岁月05

最新推荐文章于 2025-11-25 12:11:25 发布

转载最新推荐文章于 2025-11-25 12:11:25 发布 · 152 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://www.bilibili.com/video/BV12J41137hu?p=32

文章标签：

#java #cmd

JavaSE基础专栏收录该内容

6 篇文章

订阅专栏

本文详细介绍如何使用JavaDoc命令为自定义Java类生成API文档。通过实例演示了注释语法，包括作者、版本、参数、返回值及异常处理等，并提供了从命令行调用javadoc工具的具体步骤。

JavaDOC命令生成自己的API文档：

创建一个java类DOS，并给类进行文档注释；

/**
 * @author beyond_csdn    作者
 * @version 1.0           版本号
 * @since 1.8             指明需要最早使用的JDK版本
 */
public class DOC {
    String name;

    /**
     *
     * @param name          参数
     * @return              返回值情况
     * @throws Exception    异常抛出情况
     */
    public String test(String name)throws Exception {
        return name;
    }
}

鼠标右击类名，点击“show in Explorer”，将进入此文件所在目录；
在目录的导航栏中，文件路径的前面，输入“cmd ”，然后回车，进入命令行窗口；
在命令行窗口输入“javadoc -encoding UTF-8 -charset UTF-8 DOC.java”回车，则该目录下生成一些相关文件，选中“index.html”文件并打开，就可看到自己的API文档。