javaDoc簡介And基礎(chǔ)知識(shí)

(一) Java注釋類型

//用于單行注釋。

/*...*/用于多行注釋，從/*開始，到*/結(jié)束，不能嵌套。

/**...*/則是為支持jdk工具javadoc.exe而特有的注釋語句。

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

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

1. 通用注釋

注釋中可以出現(xiàn)的關(guān)鍵字以@開始

意義

@author

作者名

@version

版本標(biāo)識(shí)

@since

最早出現(xiàn)的JDK版本

@deprecated

www.cppcns.com

引起不推薦使用的警告

@see

交叉參考

2. 方法注釋

@return

返回值

@throws

異常類及拋出條件

@param

參數(shù)名及其意義

引言

好了，介紹完

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

問題描述

各位應(yīng)該都知道發(fā)布一個(gè)Maven項(xiàng)目到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

都會(huì)造成整個(gè)發(fā)布過程失敗，解決辦法一般是一個(gè)一個(gè)的把這些@param加上去，一兩個(gè)還好，如果您的項(xiàng)目有成千上萬個(gè)呢？

解決辦法

直接修改Maven JavaDoc plugin的配置，忽略這些錯(cuò)誤：

org.apache.maven.plugins

maven-javadoc-plugin

2.10.3

attach-javadocs

jar

-Xdoclint:none

經(jīng)過測試，忽略后項(xiàng)目可以正常發(fā)布，不會(huì)有什么影響www.cppcns.com。

總結(jié)

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

本文標(biāo)題: Maven在Java8下如何忽略Javadoc的編譯錯(cuò)誤詳解

本文地址: http://www.cppcns.com/ruanjian/java/237868.html

總結(jié)

以上是生活随笔為你收集整理的java 编译 忽略错误_Maven在Java8下如何忽略Javadoc的编译错误详解的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。