c:\srcjavadoc -d doc -subpackages com.liigo 這樣就搞定了,最終生成的API文檔位于 c:\src\doc 目錄(該目錄是由javadoc.exe自動(dòng)生成的)。
成都創(chuàng)新互聯(lián)成立與2013年,公司以成都網(wǎng)站建設(shè)、網(wǎng)站建設(shè)、系統(tǒng)開發(fā)、網(wǎng)絡(luò)推廣、文化傳媒、企業(yè)宣傳、平面廣告設(shè)計(jì)等為主要業(yè)務(wù),適用行業(yè)近百種。服務(wù)企業(yè)客戶1000多家,涉及國(guó)內(nèi)多個(gè)省份客戶。擁有多年網(wǎng)站建設(shè)開發(fā)經(jīng)驗(yàn)。為企業(yè)提供專業(yè)的網(wǎng)站建設(shè)、創(chuàng)意設(shè)計(jì)、宣傳推廣等服務(wù)。 通過(guò)專業(yè)的設(shè)計(jì)、獨(dú)特的風(fēng)格,為不同客戶提供各種風(fēng)格的特色服務(wù)。
進(jìn)入java源文件目錄。通過(guò)cd等windows命令進(jìn)入java源文件包所在的磁盤位置。查看javadoc命令使用說(shuō)明。如果是第一次使用javadoc命令,可以通過(guò)javadoc -help命令查看javadoc使用說(shuō)明。開始創(chuàng)建api文件。
Javadoc注釋由Javadoc標(biāo)簽和描述性文本組成,你可以為類、接口添加注釋,也可為構(gòu)造函數(shù)、值域、方法等類中的元素添加注釋。
首先,打開Eclipse,在需要生成Javadoc的項(xiàng)目上右擊鼠標(biāo),在彈出來(lái)的列表中點(diǎn)擊”導(dǎo)出(O)...“選項(xiàng)。在彈出來(lái)的”導(dǎo)出“窗口中,選擇導(dǎo)出的目標(biāo),這里選擇Java文件夾下的Javadoc,然后點(diǎn)擊”下一步(N)“按鈕。
JavaDoc就是JDK中的一個(gè)開發(fā)工具,可以通過(guò)JavaDoc自動(dòng)提取在程序(*.java文件)中的注釋,直接生成幫助文檔(Java API)。
其中的javadoc就是文檔工具,用來(lái)自動(dòng)根據(jù)代碼中的帶有特定格式的注釋來(lái)生成HTML格式的文檔。典型的一個(gè)例子就是Java官網(wǎng)的API解釋。這些文檔就是根據(jù)Java源代碼中的注釋自動(dòng)生成的。
Javadoc是Sun公司提供的一個(gè)技術(shù),它從程序源代碼中抽取類、方法、成員等注釋形成一個(gè)和源代碼配套的API幫助文檔。
javadoc 命令是用來(lái)生成文檔的。確保你的hello.java 文件里面有些注釋。否則就是空的。
javadoc 是java編程注釋規(guī)范,命令行?啥意思,它并不是指令。
文檔注釋以斜線后緊跟兩個(gè)星號(hào)(/**)開始,以星號(hào)后緊跟一個(gè)斜線(*/)作為結(jié)尾,中間部分全部都是文檔注釋,會(huì)被提取到API文檔中。
執(zhí)行命令:mvn javadoc:javadoc 就可以了 所在目錄:target/javadoc/apidocs 文檔注釋是自動(dòng)生成的,只要你在java文件中寫了類以及方法的注釋。
第一步:在工程目錄的 src下創(chuàng)建 文件:package.txt .我的路徑是這樣的:F:\watermusic\MyProject\zwhy\MyUtil\src ,即:在src 下創(chuàng)建,package.txt 。
方法的簡(jiǎn)單注釋,是注釋第一行最后一個(gè)點(diǎn)號(hào)“.”之前的,之后的將在下面詳細(xì)的敘述部分出現(xiàn)。如果方法簡(jiǎn)述的第一行最后沒(méi)有點(diǎn)號(hào)(哪怕中間有點(diǎn)好),解析的時(shí)候會(huì)自動(dòng)查找下面行的最近最后出現(xiàn)行末尾的點(diǎn)號(hào)。
在代碼里用文檔注釋方法進(jìn)行注釋 / 注釋內(nèi)容 / 用cmd進(jìn)去源代碼文件目錄 輸入指令javadoc -d MyAPIdoc xxx.java 敲回車就能在該目錄下生成文件了,這是比較簡(jiǎn)單的一句話,當(dāng)然還可以附加其他參數(shù)設(shè)置標(biāo)題等。
網(wǎng)站名稱:javadoc代碼 java代碼例子講解
文章起源:http://jinyejixie.com/article2/dccoiic.html
成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供小程序開發(fā)、網(wǎng)站改版、定制開發(fā)、關(guān)鍵詞優(yōu)化、網(wǎng)站內(nèi)鏈、網(wǎng)站建設(shè)
聲明:本網(wǎng)站發(fā)布的內(nèi)容(圖片、視頻和文字)以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主,如果涉及侵權(quán)請(qǐng)盡快告知,我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng),如需處理請(qǐng)聯(lián)系客服。電話:028-86922220;郵箱:631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載,或轉(zhuǎn)載時(shí)需注明來(lái)源: 創(chuàng)新互聯(lián)