文檔注釋與javadoc

注釋:

?單行注釋用雙斜線 ”//”表示

?多行注釋用/*------------------*/表示

?文檔注釋用/**-----------------*/表示


文檔注釋通過javadoc命令來生成API文檔步驟如下:

1. 創(chuàng)建java源文件包

※?java文件都是存放在一個(gè)package包中,這樣方便對(duì)java文件進(jìn)行操作和區(qū)分,首先在磁盤上創(chuàng)建文件夾一樣的方式創(chuàng)建package包吝镣。

2. 創(chuàng)建java源文件

※?在包下针贬,創(chuàng)建與文件名相同的java源文件喊积,輸入一些文檔注釋椰拒,這些文檔注釋用于自動(dòng)的api文件進(jìn)行說明使用逊朽。

3. 進(jìn)入java源文件目錄

通過cd等windows命令進(jìn)入java源文件包所在的磁盤位置罕伯。

4. 查看javadoc命令使用說明

※?如果是第一次使用javadoc命令,可以通過javadoc -help命令查看javadoc使用說明叽讳。?

5. 開始創(chuàng)建api文件

※?使用命令輸入

" javadoc -d javaapi -header 測(cè)試的API -doctitle 這是我的第一個(gè)文檔注釋 -version -author javadoc/Hello.java ?" 進(jìn)行文檔生成追他。

-d:文件存儲(chǔ)位置; -head:文件頭部名稱; -version:顯示版本; -author:顯示作者; javadoc/Hello.java 處理的文件包以及java源文件.?

6. 查看生成的api文件

※?創(chuàng)建成功之后,就會(huì)自動(dòng)創(chuàng)建指定的文件夾下生成api文件岛蚤。打開index.html就是api文件的入口邑狸。?


?API文檔包括三個(gè)區(qū)域分別是:包區(qū)域,類區(qū)域,詳細(xì)說明區(qū)域

?注:如果要出現(xiàn)包區(qū)域,要讓不同類處于不同的包下面才會(huì)出現(xiàn)包區(qū)域。

如下:

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末涤妒,一起剝皮案震驚了整個(gè)濱河市单雾,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌她紫,老刑警劉巖硅堆,帶你破解...
    沈念sama閱讀 217,826評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異贿讹,居然都是意外死亡渐逃,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,968評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門民褂,熙熙樓的掌柜王于貴愁眉苦臉地迎上來茄菊,“玉大人疯潭,你說我怎么就攤上這事÷蛐撸” “怎么了袁勺?”我有些...
    開封第一講書人閱讀 164,234評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)畜普。 經(jīng)常有香客問我,道長(zhǎng)群叶,這世上最難降的妖魔是什么吃挑? 我笑而不...
    開封第一講書人閱讀 58,562評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮街立,結(jié)果婚禮上舶衬,老公的妹妹穿的比我還像新娘。我一直安慰自己赎离,他們只是感情好逛犹,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,611評(píng)論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著梁剔,像睡著了一般虽画。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上荣病,一...
    開封第一講書人閱讀 51,482評(píng)論 1 302
  • 那天码撰,我揣著相機(jī)與錄音,去河邊找鬼个盆。 笑死脖岛,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的颊亮。 我是一名探鬼主播柴梆,決...
    沈念sama閱讀 40,271評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長(zhǎng)吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼终惑!你這毒婦竟也來了绍在?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,166評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤狠鸳,失蹤者是張志新(化名)和其女友劉穎揣苏,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體件舵,經(jīng)...
    沈念sama閱讀 45,608評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡卸察,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,814評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了铅祸。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片坑质。...
    茶點(diǎn)故事閱讀 39,926評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡合武,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出涡扼,到底是詐尸還是另有隱情稼跳,我是刑警寧澤,帶...
    沈念sama閱讀 35,644評(píng)論 5 346
  • 正文 年R本政府宣布吃沪,位于F島的核電站汤善,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏票彪。R本人自食惡果不足惜红淡,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,249評(píng)論 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望降铸。 院中可真熱鬧在旱,春花似錦、人聲如沸推掸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,866評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)谅畅。三九已至登渣,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間铃彰,已是汗流浹背绍豁。 一陣腳步聲響...
    開封第一講書人閱讀 32,991評(píng)論 1 269
  • 我被黑心中介騙來泰國(guó)打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留牙捉,地道東北人竹揍。 一個(gè)月前我還...
    沈念sama閱讀 48,063評(píng)論 3 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像邪铲,于是被迫代替她去往敵國(guó)和親芬位。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,871評(píng)論 2 354

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

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理带到,服務(wù)發(fā)現(xiàn)昧碉,斷路器,智...
    卡卡羅2017閱讀 134,656評(píng)論 18 139
  • Android 自定義View的各種姿勢(shì)1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,118評(píng)論 25 707
  • 冰冰對(duì)一個(gè)比自己大10歲的男人一見鐘情揽惹,雖然他們兩個(gè)都有各自的婚姻和生活被饿。這個(gè)男的對(duì)她有沒有來電,冰冰絲毫不知搪搏,只...
    草頭三心閱讀 1,394評(píng)論 8 20