javadoc基本介紹
javadoc是Sun公司提供的一個技術(shù)承绸，它從程序源代碼中抽取類、方法挣轨、成員等注釋形成一個和源代碼配套的API幫助文檔军熏。也就是說，只要在編寫程序時以一套特定的標(biāo)簽作注釋卷扮，在程序編寫完成后荡澎，通過Javadoc就可以同時形成程序的開發(fā)文檔了均践。
javadoc命令是用來生成自己API文檔的，使用方式：使用命令行在目標(biāo)文件所在目錄輸入javadoc +文件名.java摩幔。
javadoc常用標(biāo)識
@author 作者
@version 版本號
@param 參數(shù)名 描述 方法的入?yún)⒚懊枋鲂畔⒆腔缛雲(yún)⒂刑貏e要求，可在此注釋热鞍。
@return 描述 對函數(shù)返回值的注釋
@deprecated 過期文本 標(biāo)識隨著程序版本的提升，當(dāng)前API已經(jīng)過期衔彻，僅為了保證兼容性依然存在薇宠，以此告之開發(fā)者不應(yīng)再用這個API。
@throws異常類名 構(gòu)造函數(shù)或方法所會拋出的異常艰额。
@exception 異常類名 同@throws澄港。
@see 引用 查看相關(guān)內(nèi)容，如類柄沮、方法回梧、變量等。
@since 描述文本 API在什么程序的什么版本后開發(fā)支持祖搓。
{@link包.類#成員 標(biāo)簽} 鏈接到某個特定的成員對應(yīng)的文檔中狱意。
{@value} 當(dāng)對常量進(jìn)行注釋時，如果想將其值包含在文檔中拯欧，則通過該標(biāo)簽來引用常量的值详囤。
第一步：在工具欄中找到 Tool，然后再子菜單中找到 Generate JavaDoc镐作。
第二步：在生成文檔上進(jìn)行配置藏姐。
配置的簡單介紹：
參數(shù)說明
1.Whole project:整個項(xiàng)目都生成文檔
2.Custom scope 自定義范圍。如下：
（1）project files 項(xiàng)目文件该贾，
（2）project production files 項(xiàng)目產(chǎn)品文件羔杨，
（3）project test files 項(xiàng)目的測試文件， 未知范圍杨蛋，class hierarchy 類層
3.include test source 包含測試目錄
4.include JDK and … 包含jdk和其他的第三方j(luò)ar
5.link to JDK documentation…鏈接到JDK api
6.output directy 生成的文檔存放的位置
（1）private兜材、package、protected六荒、public 生成文檔的級別（類和方法）
（2）右邊的Generate…是選擇生成的文檔包含的內(nèi)容护姆，層級樹、導(dǎo)航掏击、索引..
（3）再右邊是生成的文檔包含的內(nèi)容信息卵皂，作者版本等信息
7.Locale 語言類型,zh-CN
8.Other command line arguments 其他參數(shù)
9.Maximum heep… 最大堆棧
我這里的配置如下：
說明：IntelliJ IDEA作為Java流行的編輯器, 其生成一些Javadoc會對中文亂碼, 使用UTF-8編碼即可. 這個常見的問題, 則需要生成時設(shè)置參數(shù)即可.
在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 欄里輸入 ：
傳入JavaDoc的參數(shù)，一般這樣寫
-encoding UTF-8 -charset UTF-8 -windowtitle "文檔HTML頁面標(biāo)簽的標(biāo)題" -link http://docs.Oracle.com/javase/7/docs/api
不然的話會報可能會報錯誤: 編碼GBK的不可映射字符砚亭。
