昨天在工作中遇到一个编译方面的错误,跟javadoc有关,跟同事讨论后才知道有这个好东西。
首先如果在pom中加入了javadoc的maven插件,那么在子模块中使用clean compile
install就会报错一大堆,关于代码注释的错误,而且控制台还可能是乱码,遇到这个问题不用慌,如果仅仅需要编译maven项目的其中一个子模块只要在maven命令后面加入一个命令即可,如:clean
compile install package –D
maven.javadoc.skip=true,然后执行,就会发现日志中会跳过生成javadoc的过程。如何添加javadoc插件呢,只要在父pom.xml里面的添加如下代码:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<charset>UTF-8</charset>
<docencoding>UTF-8</docencoding>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
那么执行父pom.xml会出现什么呢,在target包中会出现两个包,一个是class包,一个是带有java文档的包。
带有java文档的包一般用于api的说明,如何使用该jar包,而class包则是编译好的jar包。
两个包的包名的区别是一个带有javadoc,一个没有。
将javadoc的包解压打开后,会发现有HTML文件,默认有个index.html,打开后你会发现跟JDK1.7的中文帮助文档很像,相当于在线API文档一样,如果你想用该插件的话,会有想不到的惊喜哦。