javadoc是Sun公司提供的一個技術，它從程序源代碼中抽取類、方法、成員等注釋形成一個和源代碼配套的API幫助文檔。也就是說，只要在編寫程序時以一套特定的標簽作注釋，在程序編寫完成后，通過Javadoc就可以同時形成程序的開發文檔了。
javadoc命令是用來生成自己API文檔的，使用方式：使用命令行在目標文件所在目錄輸入javadoc +文件名.java。
| 標簽 | 說明 | JDK 1.1 doclet | 標準doclet | 標簽類型 |
| @author 作者 | 作者標識 | √ | √ | 包、 類、接口 |
| @version 版本號 | 版本號 | √ | √ | 包、 類、接口 |
| @param 參數名 描述 | 方法的入參名及描述信息，如入參有特別要求，可在此注釋。 | √ | √ | 構造函數、 方法 |
| @return 描述 | 對函數返回值的注釋 | √ | √ | 方法 |
| @deprecated 過期文本 | 標識隨著程序版本的提升，當前API已經過期，僅為了保證兼容性依然存在，以此告之開發者不應再用這個API。 | √ | √ | 包、類、接口、值域、構造函數、 方法 |
| @throws異常類名 | 構造函數或方法所會拋出的異常。 | √ | 構造函數、 方法 | |
| @exception 異常類名 | 同@throws。 | √ | √ | 構造函數、 方法 |
| @see 引用 | 查看相關內容，如類、方法、變量等。 | √ | √ | 包、類、接口、值域、構造函數、 方法 |
| @since 描述文本 | API在什么程序的什么版本后開發支持。 | √ | √ | 包、類、接口、值域、構造函數、 方法 |
| {@link包.類#成員 標簽} | 鏈接到某個特定的成員對應的文檔中。 | √ | 包、類、接口、值域、構造函數、 方法 | |
| {@value} | 當對常量進行注釋時，如果想將其值包含在文檔中，則通過該標簽來引用常量的值。 | √(JDK1.4) | 靜態值域 |
此外還有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}幾個不常用的標簽，由于不常使用，我們展開敘述，感興趣的讀者可以查看幫助文檔。
那我們如何通過Intellij IDEA如何生成JavaDoc？
配置的簡單介紹：
參數說明
1.Whole project:整個項目都生成文檔 2.Custom scope 自定義范圍。如下： （1）project files 項目文件， （2）project production files 項目產品文件， （3）project test files 項目的測試文件， 未知范圍，class hierarchy 類層 3.include test source 包含測試目錄 4.include JDK and … 包含jdk和其他的第三方jar 5.link to JDK documentation…鏈接到JDK api 6.output directy 生成的文檔存放的位置 （1）private、package、protected、public 生成文檔的級別（類和方法） （2）右邊的Generate…是選擇生成的文檔包含的內容，層級樹、導航、索引.. （3）再右邊是生成的文檔包含的內容信息，作者版本等信息 7.Locale 語言類型,zh-CN 8.Other command line arguments 其他參數 9.Maximum heep… 最大堆棧
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
1.Whole project:整個項目都生成文檔 2.Custom scope 自定義范圍。如下： （1）project files 項目文件， （2）project production files 項目產品文件， （3）project test files 項目的測試文件， 未知范圍，class hierarchy 類層 3.include test source 包含測試目錄 4.include JDK and … 包含jdk和其他的第三方jar 5.link to JDK documentation…鏈接到JDK api 6.output directy 生成的文檔存放的位置 （1）private、package、protected、public 生成文檔的級別（類和方法） （2）右邊的Generate…是選擇生成的文檔包含的內容，層級樹、導航、索引.. （3）再右邊是生成的文檔包含的內容信息，作者版本等信息 7.Locale 語言類型,zh-CN 8.Other command line arguments 其他參數 9.Maximum heep… 最大堆棧
|
我這里的配置如下：
說明：IntelliJ IDEA作為Java流行的編輯器, 其生成一些Javadoc會對中文亂碼, 使用UTF-8編碼即可. 這個常見的問題, 則需要生成時設置參數即可.
在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 欄里輸入 ：
-encoding utf-8 -charset utf-8
|
1 |
-encoding utf-8 -charset utf-8 |
不然的話會報可能會報錯誤: 編碼GBK的不可映射字符。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
