Maven生成javadoc

1.pom配置

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<reportOutputDirectory>../javadocs</reportOutputDirectory>
<destDir>easy-delivery</destDir>
</configuration>
</plugin>

这里指明了文档输出的位置。如果生成过程中出现中文乱码，可能需要加如下的配置。

<properties>
<maven.compiler.encoding>UTF-8</maven.compiler.encoding>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

properties与dependencys同级

2.生成doc命令

首先需要cd到项目目录下，然后执行下面命令即可

mvn javadoc:javadoc

3.查看文件

比如我的项目在intellij这个文件夹下面，doc也会生成在与intellij同级目录（也可以修改上面的配置）

打开index.html



这样我们就成功生成了。

有时候我们注释不规范导致注释内容丢失，所以规范的注释是有必要的。可以随便打开一个官方类查看标准注释，比如说Map,规范自己的注释。