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 |
引起不推薦使用的警告 |
|
@see |
交叉參考 |
2. 方法注釋
|
@return |
返回值 |
|
@throws |
異常類及拋出條件 |
|
@param |
參數(shù)名及其意義 |
引言
好了，介紹完一些基本的知識(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，而我們?cè)谑褂胢aven 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
都會(huì)造成整個(gè)發(fā)布過程失敗，解決辦法一般是一個(gè)一個(gè)的把這些@param加上去，一兩個(gè)還好，如果您的項(xiàng)目有成千上萬個(gè)呢？
解決辦法
直接修改maven javadoc plugin的配置，忽略這些錯(cuò)誤：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<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)過測(cè)試，忽略后項(xiàng)目可以正常發(fā)布，不會(huì)有什么影響。
總結(jié)
以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，如果有疑問大家可以留言交流，謝謝大家對(duì)服務(wù)器之家的支持。
原文鏈接：http://www.liumapp.com/articles/2018/08/22/1534905949519.html
