最近一直在做android開發，昨天經理讓我寫個接口SDK做個接口文檔，以便后面的開發。

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

后來查了下資料，JDK有個自帶的Javadoc，可以根據代碼中的注釋自動生成文檔。一下子世界變亮了有木有！！

文檔可以自動生成，那生成文檔我依據是什么？

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

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

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

考慮到我只要實現網絡數據的請求，不需要提供任何界面，這里就選擇了Java工程。

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

首先學會怎么將工程打包成一個jar包(記得學java的第一節課上過)

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

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

3 選擇需要導出的工程、導出路徑以及jar包的名字，點擊finish

這樣就能在改路徑下找到我們生成的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中輸入 -encodingutf-8 -charset utf-8? 就可以了

就這樣搞定了。

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

乖乖做SDK去。。。

參考博文：

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。