IDEA自动生成JavaDoc文档

最新推荐文章于 2024-04-21 08:00:34 发布

专业的小白

最新推荐文章于 2024-04-21 08:00:34 发布

阅读量523

点赞数

文章标签： java

本文链接：https://blog.csdn.net/lClarance/article/details/115711841

版权

一、IDEA编译器自带的Generate JavaDoc工具

点击Tools->Generate JavaDoc…；
在Output directory中选择要输出文档的路径；
勾选需要输出的注释标记；
Locale：设置文档输出的语言，一般为zh_CN；
在Other command line arguments设置输出参数-encoding UTF-8 -charset UTF-8避免出现乱码错误；
最后点击OK尝试生成JavaDoc文档，生成成功后，在指定的文件夹中打开index.html进行查看。

二、使用maven-javadoc-plugin插件

在pom文件中引入JavaDoc插件：

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <configuration>
                    <aggregate>true</aggregate>
                    <destDir>sw-arm-javadoc</destDir>
                    <tags>
                        <tag>
                            <name>description</name>
                            <placement>a</placement>
                            <head>描述</head>
                        </tag>
                    </tags>
                </configuration>
            </plugin>

aggregate：是否整合子模块
destDir：指定的文件夹名称，默认与pom文件同级
reportOutputDirectory：指定输出的路径
doclint：指定检查范围，none跳过所有检查，all检查所有
tags：自定义标记
- name：标记名
- placement：标记适用的位置，a代表all
- head：前置提示

在工作文件下执行maven命令mvn javadoc:javadoc，即可检查并输出JavaDoc文档；
如果提示编码格式错误，可以在Settings->Build,Execute,Deployment->Build Tools->Maven->Runner的VM Options中输入虚拟机命令-Dfile.encoding=GBK解决该问题。

专业的小白

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
IDEA自动生成JavaDoc文档

一、IDEA编译器自带的Generate JavaDoc工具点击Tools->Generate JavaDoc…；在Output directory中选择要输出文档的路径；勾选需要输出的注释标记；Locale：设置文档输出的语言，一般为zh_CN；在Other command line arguments设置输出参数-encoding UTF-8 -charset UTF-8避免出现乱码错误；最后点击OK尝试生成JavaDoc文档，生成成功后，在指定的文件夹中打开index.html进行
复制链接

扫一扫