JavaDoc簡介And基礎知識

(一) Java注釋類型

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

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

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

1. 通用注釋

2. 方法注釋

引言

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

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>

經過測試，忽略后項目可以正常發布，不會有什么影響。

總結

以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對VeVb武林網的支持。