欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Maven在Java8下如何忽略Javadoc的编译错误详解

程序员文章站 2024-02-25 19:29:51
javadoc简介and基础知识 (一) java注释类型 //用于单行注释。 /*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。 /*...

javadoc简介and基础知识

(一) java注释类型

  • //用于单行注释。
  • /*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。
  • /**...*/则是为支持jdk工具javadoc.exe而特有的注释语句。

说明:javadoc 工具能从java源文件中读取第三种注释,并能识别注释中用@标识的一些特殊变量(见表),制作成html格式的类说明文档。javadoc不但能对一个 java源文件生成注释文档,而且能对目录和包生成交叉链接的html格式的类说明文档,十分方便。

(二)javadoc中出现的@字符及其意义:

1. 通用注释

注释中可以出现的关键字以@开始

意义

@author

作者名

@version

版本标识

@since

最早出现的jdk版本

@deprecated

引起不推荐使用的警告  

@see

交叉参考

2. 方法注释

@return

返回值

@throws

异常类及抛出条件

@param

参数名及其意义

引言

好了,介绍完一些基本的知识,下面开始本文的正文。

java8对javadoc的语法检查非常严格,我在进行maven编译发布项目到maven center的过程中,经常产生因为javadoc编译失败造成发布失败,但是很多情况下,都是一两个@param参数没有写全,@return没有写之类的问题,为此,我觉得非常有必要忽略这些异常。

问题描述

各位应该都知道发布一个maven项目到maven的*仓库是必须要有javadoc,而我们在使用maven javadoc plugin的过程中,一旦出现某些类似于此的问题:

failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:2.7:jar (attach-javadocs) on project [projectname]: mavenreportexception: error while creating archive:
exit code: 1 - [path-to-file]:[linenumber]: warning: no description for @param

都会造成整个发布过程失败,解决办法一般是一个一个的把这些@param加上去,一两个还好,如果您的项目有成千上万个呢?

解决办法

直接修改maven javadoc plugin的配置,忽略这些错误:

<plugin>
 <groupid>org.apache.maven.plugins</groupid>
 <artifactid>maven-javadoc-plugin</artifactid>
 <version>2.10.3</version>
 <executions>
 <execution>
 <id>attach-javadocs</id>
 <goals>
 <goal>jar</goal>
 </goals>
 <configuration> 
 <additionalparam>-xdoclint:none</additionalparam>
 </configuration>
 </execution>
 </executions>
</plugin>

经过测试,忽略后项目可以正常发布,不会有什么影响。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对的支持。