最近一直在做android開發，昨天經理讓我寫個介面SDK做個介面文件，以便後面的開發。

這讓我很焦灼，SDK怎麼做？要是隻有敲程式碼還好。可是那個介面文件！！！文件這東西最討厭了，頭都大了

後來查了下資料，JDK有個自帶的Javadoc，可以根據程式碼中的註釋自動生成文件。一下子世界變亮了有木有！！

文件可以自動生成，那生成文件我依據是什麼？

查下資料發現，只要在類、變數、方法上加註釋，就能自動生成文件了。這些註釋有自己的規範，可以先看看下面這篇博文

文件的事情搞定了，接下來就是SDK了。還沒開始製作就遇到一個問題：

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

考慮到我只要實現網路資料的請求，不需要提供任何介面，這裡就選擇了Java工程。

在我採用Java工程的時候，發現我需要Android中Context的時候，Java工程裡面是沒有的 ！！！  （反省中）

在這裡採用Android工程，把Activity檔案，圖片，Manifest中的application等用不上的全刪了（本sdk中沒有介面），可以右擊工程，選擇Properties-->選擇Android-->勾選 Is Library。（這樣就可以直接在專案中匯入了）

（需要提供介面的會遇到解決資原始檔不能打包的問題，這裡有篇博文需要的同學可以去看看

首先學會怎麼將工程打包成一個jar包（記得學java的第一節課上過）

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

2 在export中展開java,選擇JAR file，點選next

3 選擇需要匯出的工程、匯出路徑以及jar包的名字，點選finish（注意，android工程中的mainfest檔案不要選，不然用的時候會出問題）

這裡有幾個選項

* Export generated class files and resources 表示只匯出生成的.class檔案和其他資原始檔
* Export all output folders for checked projects 表示匯出選中專案的所有資料夾
* Export java source file and resouces 表示匯出的jar包中將包含你的原始碼*.java，如果你不想洩漏原始碼，那麼就不要選這項了
* Export refactorings for checked projects 把一些重構的資訊檔案也包含進去
 

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

jar包搞定了，接下來就輪到文件了

根據文章開頭的Javadoc語法編輯工程後，就可以生成文件了，步驟如下：

1 右擊工程，選擇export

2 在export中展開java 選擇Javadoc，點選next

3 在接下來的頁面中：

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

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

User standard doclet   選擇doc的路徑

點選next

4 使用預設設定，點選next

5 點選finish，就能在對應的目錄下找到生成的doc

開啟對應的資料夾能看到

開啟 index，就能在瀏覽器中看到剛剛生成的文件了

是不是很眼熟！！！

似曾相識。。。

跟api文件好像

在生成文件的時候可能會看到這樣的提示

“錯誤 編碼 GBK 的不可對映字元”

說明註釋中有中文。解決方法：在生成文件的最後一步Vm  options中輸入 -encoding utf-8 -charset utf-8  就可以了

就這樣搞定了。

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

乖乖做SDK去。。。

參考博文：