注釋:
?單行注釋用雙斜線 ”//”表示
?多行注釋用/*------------------*/表示
?文檔注釋用/**-----------------*/表示
文檔注釋通過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ū)域。
如下: