最近一直在做android開(kāi)發(fā)，昨天經(jīng)理讓我寫(xiě)個(gè)接口SDK做個(gè)接口文檔，以便后面的開(kāi)發(fā)。

這讓我很焦灼，SDK怎么做？要是只有敲代碼還好。可是那個(gè)接口文檔！！！文檔這東西最討厭了，頭都大了

后來(lái)查了下資料，JDK有個(gè)自帶的Javadoc，可以根據(jù)代碼中的注釋自動(dòng)生成文檔。一下子世界變亮了有木有！！

文檔可以自動(dòng)生成，那生成文檔我依據(jù)是什么？

查下資料發(fā)現(xiàn)，只要在類(lèi)、變量、方法上加注釋，就能自動(dòng)生成文檔了。這些注釋有自己的規(guī)范，可以先看看下面這篇博文

文檔的事情搞定了，接下來(lái)就是SDK了。還沒(méi)開(kāi)始制作就遇到一個(gè)問(wèn)題：

我是要新建Android工程、還是Java工程？

考慮到我只要實(shí)現(xiàn)網(wǎng)絡(luò)數(shù)據(jù)的請(qǐng)求，不需要提供任何界面，這里就選擇了Java工程。

(需要提供界面的會(huì)遇到解決資源文件不能打包的問(wèn)題，這里有篇博文需要的同學(xué)可以去看看

首先學(xué)會(huì)怎么將工程打包成一個(gè)jar包(記得學(xué)java的第一節(jié)課上過(guò))

1、在Eclipse中右擊需要打包的工程,選擇export

2 在export中展開(kāi)java,選擇JAR file，點(diǎn)擊next

3 選擇需要導(dǎo)出的工程、導(dǎo)出路徑以及jar包的名字，點(diǎn)擊finish

這樣就能在改路徑下找到我們生成的jar包了

jar包搞定了，接下來(lái)就輪到文檔了

根據(jù)文章開(kāi)頭的Javadoc語(yǔ)法編輯工程后，就可以生成文檔了，步驟如下：

1 右擊工程，選擇export

2 在export中展開(kāi)java 選擇Javadoc，點(diǎn)擊next

3 在接下來(lái)的頁(yè)面中：

Javadoc command 中選擇jdk安裝路徑下的javadoc.exe

Select types for which Javadoc will begenerated 選擇生成doc的工程

User standard doclet?? 選擇doc的路徑

點(diǎn)擊next

4 使用默認(rèn)設(shè)置，點(diǎn)擊next

5 點(diǎn)擊finish，就能在對(duì)應(yīng)的目錄下找到生成的doc

打開(kāi)對(duì)應(yīng)的文件夾能看到

打開(kāi) index，就能在瀏覽器中看到剛剛生成的文檔了

是不是很眼熟！！！

似曾相識(shí)。。。

跟api文檔好像

在生成文檔的時(shí)候可能會(huì)看到這樣的提示

“錯(cuò)誤 編碼 GBK 的不可映射字符”

說(shuō)明注釋中有中文。解決方法：在生成文檔的最后一步Vm ?options中輸入 -encodingutf-8 -charset utf-8? 就可以了

就這樣搞定了。

知道做法以后生活是不是一下子就美好了！！！

乖乖做SDK去。。。

參考博文：

總結(jié)

以上是生活随笔為你收集整理的java如何写安卓接口文档_android、java制作sdk以及自动生成文档的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。