您的当前位置:首页正文

IntelliJ IDEA快速入门 | 第三十五篇:你知道如何在IntelliJ IDEA中去生成JavaDoc吗?

2024-12-02 来源:个人技术集锦

关于IntelliJ IDEA的使用,我们还剩一些零散的点没给大家讲到,于是,下面我就为大家详细说一下这些零散的点。首先,我们来说下如何在IntelliJ IDEA中去生成JavaDoc,这是因为有的时候,我们需要为当前工程生成一个其对应的文档。接下来,我们就来看看这个文档该如何去生成。

首先,打开IntelliJ IDEA,点击菜单栏中的Tools菜单,并在其下拉列表中选中Generate JavaDoc...这一项,如下图所示。

是不是这样设置就完了呢?你想多了。在以上对话框中还有两项需要我们填写,第一项,即Locale,这是在告诉我们要输入语言类型,由于咱们都是中国人,通常生成的JavaDoc(即文档)肯定都是中文的,所以这儿输入zh_CN就行了。第二项,即Other command line arguments,这是在告诉我们要设置一个命令行的参数,这儿我们直接输入-encoding UTF-8 -charset UTF-8参数就哦了。

以上都设置完之后,点击OK按钮即可。下面你需要做的事就是等待,比较不幸的事是,这儿IntelliJ IDEA控制台给我提示了一个如下错误。

为什么会报以上这样的一个错误呢?这是因为我们之前修改了类头的文档注释信息,每写一个Java源文件,其头部都会有如下这样的文档注释信息:

/**
 * @author liayun
 * @create 2021-04-11 19:49
 */

但是在为当前整个工程去生成其相对应的文档的过程中,无法设别@create这样一个标记,所以才报了以上错误。

那么,如何解决这个问题呢?你要么把@create这样一个标记都给删除掉,要么就无视这个问题,嘿,报错误就报错误呗,我就不理你,哼,气死你?,因为此时依旧会去生成JavaDoc(即文档),只是解析不了@create这个标记而已!

打开该网页,如下图所示,就能看到帮我们生成的文档啦,有三个包,每个包下都有相关的一些类,如果你想查看某一个类的信息,例如DebugTest,那么点击它就行了。

以上就是如何在IntelliJ IDEA中去生成JavaDoc(文档)。

显示全文