JavaDoc的生成

最新推荐文章于 2023-10-30 15:50:22 发布

逍遥怪

最新推荐文章于 2023-10-30 15:50:22 发布

阅读量201

点赞数 1

分类专栏： JavaSE学习文章标签： java 前端 servlet

本文链接：https://blog.csdn.net/weixin_59169497/article/details/129185275

版权

JavaSE学习专栏收录该内容

3 篇文章 0 订阅

订阅专栏

JavaDoc的生成

文档注释

/**
     * @author L            作者名
     * @version 1.0         版本号
     * @since 1.8           指明最早使用的JDK版本
     * @param name          参数名
     * @return              返回值情况
     * @throws Exception    异常抛出情况
     * */

代码编译

package com.liu.base;
/**
 * @author liu
 * @version 1.0
 * @since 1.8
 *
 * */
public class Doc {

    String name;

    /**
     * @author L            作者名
     * @version 1.0         版本号
     * @since 1.8           指明最早使用的JDK版本
     * @param name          参数名
     * @return              返回值情况
     * @throws Exception    异常抛出情况
     * */
    public String getName(String name) throws Exception{
        return name;
    }
}

生成Doc文件

使用IEDA生成Doc文件

点击Tolls->Generate JavaDoc（图1）

对JavaDoc生成文件进行配置（图2），配置完成后点击Generate，会在指定文件夹下生成JavaDoc文件，

其中参数为-encoding UTF-8 -charset UTF-8，为了指定编码和字符集格式以免出错。

打开index.html文件（图3）

点击打开Doc（图4）

查看Doc文件（图5）

使用cmd生成Doc文件

找到对应代码保存的文件夹，并在文件地址前输入 cmd+空格（图6）

输入javadoc -d ./doc -encoding UTF-8 -charset UTF-8 Doc.java（图7）

命令格式： javadoc -d 文档存储目录 -encoding utf-8 charset utf-8 -sourcepath 源文件所在目录 -subpackages 需要生成的源文件目录包 -version -author

参数	说明
-d	API生成目录，默认为当前目录。
-encoding UTF-8	表示源代码（含有符合 JavaDoc 标准的注释）是基于 UTF-8 编码的，以免处理过程中出现中文等非英语字符乱码。
-charset UTF-8	表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码。
-sourcepath	指定源代码路径，默认为当前目录。
-subpackages	以递归的方式处理各子包。如果不使用本参数，每次只能处理一个子包（或需手工列出所有子包）。
-author	将作者信息生成到API文档中。
-version	将版本信息生成到API文档中。
-windowtitle	设置API文档的浏览器窗口标题。
-doctitle	设置概述页面标题。
-header	设置页面的页眉。