javadoc生成文件

最新推荐文章于 2022-04-07 22:31:31 发布

Zi°

最新推荐文章于 2022-04-07 22:31:31 发布

阅读量202

点赞数

分类专栏： java 文章标签： java

本文链接：https://blog.csdn.net/zi599599/article/details/107505248

版权

java 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

本文介绍了两种生成JavaDoc文件的方法。方法一是通过命令行，使用`javadoc -encoding UTF-8 -charset UTF-8 Doc.java`命令，生成的文件可以在index.html中查看。若命令行操作遇到权限问题，可尝试以管理员身份运行。方法二是利用IntelliJ IDEA的Generate JavaDoc功能，选择项目范围，设置输出路径和文档语言，通过其他命令行参数定制选项。

摘要由CSDN通过智能技术生成

javaDoc生成文件

package com.lnzi.base;
/*
@author 作者名
@version 版本号
@since  这么需要最早使用的jdk版本
@param 参数名
@return 返回值
@throws 异常抛出情况
 */

/**
 * @author lzi
 * @version 1.0
 * @since 1.8
 */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
    }
}

方法一

在我的电脑找到这个文件，然后在地址栏最前面加上cmd和空格
打开cmd 输入
javadoc -encoding UTF-8 -charset UTF-8 Doc.java

在这里插入图片描述

返回文件夹中就会多了很多文件，可以打开index.hetml看看

注意：如果在地址栏行不通，就在开始那里找到命令提示符，右键以管理员身份运行，然后进去到文档位置
我昨天直接在地址栏那个弄不了，手动进去的，但是今天就可以了。
在这里插入图片描述

方法二

在IntelliJ IDEA 中生成

点开tools在点击Generate JavaDoc

在这里插入图片描述

选择是整个项目还是模块还是单个文件文档输出路径
Locale 选择地区，这个决定了文档的语言，中文就是zh_CN
Other command line arguments： -encoding UTF-8 -charset UTF-8 -windowtitle “网页标签随意” -link http://docs.Oracle.com/javase/7/docs/api