Java 杂谈扣丁学堂Java培训

扣丁学堂解析Maven在Java8下如何忽略Javadoc编译错

2018-08-24  本文已影响1人  994d14631d16

  今天扣丁学堂Java培训老师给大家介绍一下关于Maven在Java8下如何忽略Javadoc的编译错误,下面我们通过示例代码一起来看一下吧。

​  (一)Java注释类型

  //用于单行注释。

  /*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。

  /**...*/则是为支持jdk工具javadoc.exe而特有的注释语句。

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

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

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

  问题描述

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

  Failedtoexecutegoalorg.apache.maven.plugins:maven-javadoc-plugin:2.7:jar(attach-javadocs)onproject[projectname]:MavenReportException:Errorwhilecreatingarchive:

  Exitcode:1-[path-to-file]:[linenumber]:warning:nodescriptionfor@param

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

  解决办法

  直接修改MavenJavaDocplugin的配置,忽略这些错误:

  

  org.apache.maven.plugins

  maven-javadoc-plugin

  2.10.3

  

  

  attach-javadocs

  

  jar

  

  -Xdoclint:none

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

  以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对扣丁学堂的支持。

上一篇下一篇

猜你喜欢

热点阅读