Maven在Java8下如何忽略Javadoc的編譯錯誤詳解

更新時間：2018年08月23日 08:42:08 作者：劉美勝奇

這篇文章主要給大家介紹了關(guān)于Maven在Java8下如何忽略Javadoc的編譯錯誤的相關(guān)資料，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

JavaDoc簡介And基礎(chǔ)知識

(一) Java注釋類型

//用于單行注釋。
/*...*/用于多行注釋，從/*開始，到*/結(jié)束，不能嵌套。
/**...*/則是為支持jdk工具javadoc.exe而特有的注釋語句。

說明：javadoc 工具能從java源文件中讀取第三種注釋，并能識別注釋中用@標識的一些特殊變量（見表），制作成Html格式的類說明文檔。javadoc不但能對一個 java源文件生成注釋文檔，而且能對目錄和包生成交叉鏈接的html格式的類說明文檔，十分方便。

(二)JavaDoc中出現(xiàn)的@字符及其意義：

1. 通用注釋

注釋中可以出現(xiàn)的關(guān)鍵字以@開始	意義
@author	作者名
@version	版本標識
@since	最早出現(xiàn)的JDK版本
@deprecated	引起不推薦使用的警告
@see	交叉參考

2. 方法注釋

@return	返回值
@throws	異常類及拋出條件
@param	參數(shù)名及其意義

引言

好了，介紹完一些基本的知識，下面開始本文的正文。

Java8對JavaDoc的語法檢查非常嚴格，我在進行Maven編譯發(fā)布項目到Maven Center的過程中，經(jīng)常產(chǎn)生因為JavaDoc編譯失敗造成發(fā)布失敗，但是很多情況下，都是一兩個@param參數(shù)沒有寫全，@return沒有寫之類的問題，為此，我覺得非常有必要忽略這些異常。

問題描述

各位應(yīng)該都知道發(fā)布一個Maven項目到Maven的中央倉庫是必須要有JavaDoc，而我們在使用Maven JavaDoc plugin的過程中，一旦出現(xiàn)某些類似于此的問題：

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

都會造成整個發(fā)布過程失敗，解決辦法一般是一個一個的把這些@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>

經(jīng)過測試，忽略后項目可以正常發(fā)布，不會有什么影響。

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

您可能感興趣的文章: