Maven javaDoc plugin插件使用说明&maven编译乱码解决方案

昨天在工作中遇到一个编译方面的错误,跟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文档一样,如果你想用该插件的话,会有想不到的惊喜哦。

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值