Intellij IDEA如何生成JavaDoc

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镐作。

image

第二步:在生成文檔上進(jìn)行配置藏姐。

配置的簡單介紹:

image

參數(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… 最大堆棧

我這里的配置如下:

image

說明: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的不可映射字符砚亭。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末灯变,一起剝皮案震驚了整個濱河市殴玛,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌添祸,老刑警劉巖滚粟,帶你破解...
    沈念sama閱讀 222,729評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異刃泌,居然都是意外死亡凡壤,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,226評論 3 399
  • 文/潘曉璐 我一進(jìn)店門耙替,熙熙樓的掌柜王于貴愁眉苦臉地迎上來亚侠,“玉大人,你說我怎么就攤上這事俗扇∠趵茫” “怎么了?”我有些...
    開封第一講書人閱讀 169,461評論 0 362
  • 文/不壞的土叔 我叫張陵铜幽,是天一觀的道長滞谢。 經(jīng)常有香客問我,道長除抛,這世上最難降的妖魔是什么狮杨? 我笑而不...
    開封第一講書人閱讀 60,135評論 1 300
  • 正文 為了忘掉前任,我火速辦了婚禮到忽,結(jié)果婚禮上禾酱,老公的妹妹穿的比我還像新娘。我一直安慰自己绘趋,他們只是感情好颤陶,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,130評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著陷遮,像睡著了一般滓走。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上帽馋,一...
    開封第一講書人閱讀 52,736評論 1 312
  • 那天搅方,我揣著相機(jī)與錄音,去河邊找鬼绽族。 笑死姨涡,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的吧慢。 我是一名探鬼主播涛漂,決...
    沈念sama閱讀 41,179評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了匈仗?” 一聲冷哼從身側(cè)響起瓢剿,我...
    開封第一講書人閱讀 40,124評論 0 277
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎悠轩,沒想到半個月后间狂,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,657評論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡火架,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,723評論 3 342
  • 正文 我和宋清朗相戀三年鉴象,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片何鸡。...
    茶點(diǎn)故事閱讀 40,872評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡炼列,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出音比,到底是詐尸還是另有隱情,我是刑警寧澤氢惋,帶...
    沈念sama閱讀 36,533評論 5 351
  • 正文 年R本政府宣布洞翩,位于F島的核電站,受9級特大地震影響焰望,放射性物質(zhì)發(fā)生泄漏骚亿。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,213評論 3 336
  • 文/蒙蒙 一熊赖、第九天 我趴在偏房一處隱蔽的房頂上張望来屠。 院中可真熱鬧,春花似錦震鹉、人聲如沸俱笛。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,700評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽迎膜。三九已至,卻和暖如春浆兰,著一層夾襖步出監(jiān)牢的瞬間磕仅,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,819評論 1 274
  • 我被黑心中介騙來泰國打工簸呈, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留榕订,地道東北人。 一個月前我還...
    沈念sama閱讀 49,304評論 3 379
  • 正文 我出身青樓蜕便,卻偏偏與公主長得像劫恒,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子轿腺,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,876評論 2 361

推薦閱讀更多精彩內(nèi)容