javadoc基本介紹
javadoc是Sun公司提供的一個技術,它從程序源代碼中抽取類、方法、成員等註釋形成一個和源代碼配套的API幫助文檔。也就是說,只要在編寫程序時以一套特定的標籤作註釋,在程序編寫完成後,通過Javadoc就可以同時形成程序的開發文檔了。
javadoc命令是用來生成自己API文檔的,使用方式:使用命令行在目標文件所在目錄輸入javadoc +文件名.java。
javadoc常用標識
@author 作者
@version 版本號
@param 參數名 描述 方法的入參名及描述信息,如入參有特別要求,可在此註釋。
@return 描述 對函數返回值的註釋
@deprecated 過期文本 標識隨着程序版本的提升,當前API已經過期,僅爲了保證兼容性依然存在,以此告之開發者不應再用這個API。
@throws異常類名 構造函數或方法所會拋出的異常。
@exception 異常類名 同@throws。
@see 引用 查看相關內容,如類、方法、變量等。
@since 描述文本 API在什麼程序的什麼版本後開發支持。
{@link包.類#成員 標籤} 鏈接到某個特定的成員對應的文檔中。
{@value} 當對常量進行註釋時,如果想將其值包含在文檔中,則通過該標籤來引用常量的值。
第一步:在工具欄中找到 Tool,然後再子菜單中找到 Generate 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… 最大堆棧
我這裏的配置如下:
在 “Tools->Gerenate JavaDoc” 面版的 “Other command line arguments:” 欄裏輸入 :
傳入JavaDoc的參數,一般這樣寫
-encoding UTF-8 -charset UTF-8 -windowtitle "文檔HTML頁面標籤的標題" -link http://docs.Oracle.com/javase/7/docs/api
不然的話會報可能會報錯誤: 編碼GBK的不可映射字符。
-encoding UTF-8 -charset UTF-8