Sunday, December 28, 2014

[Android Studio] 替Jar檔添加Jovadoc文件讓寫Code更方便

文章攢寫時間︰2014/12/29 12:12

一、前言

在下載第3方套件(jar檔)時,
常會看到除了xxx.jar檔外,
還有xxx-javadoc.jar、xxx-sources.jar,
這些jar檔其實是讓你在寫程式時,
可以看的到jar的說明和用法(更詳細的解說請參考GTW部落格)。


二、文章開始

在Android Studio要怎麼樣替jar檔添加javadoc呢?

步驟1

假設我們已經在用xxx.jar檔,
為了能看到jar檔的說明文件,
我們額外將xxx-source.jar也放進libs資料夾。

步驟2

在您想看的函式或Class位置(譬如我現在想看在jar檔裡TimeObserver這個類別是幹嘛用的),
點擊Ctrl(Windows環境) / Command(Mac環境)+滑鼠左鍵
此時會看到類似以下的畫面。
在未與javadoc連結時,
看到的都是封裝的程式源碼。

步驟3

1.點擊右上角Attach Sources...
2.選擇剛才加入的xxx.sources.jar檔

此時可以看到,
jar檔的源始碼和說明文件通通都顯示岀來了。

滑鼠移到類別名稱或函式上,
也會自動跳岀說明。

如果沒有跳岀說明視窗,到
[Android Studio]-->[Preferences]-->[Editor]-->將[Show quick doc on mouse move Delay(ms)]打勾-->[Apply]
就會看到說明視窗囉!

參考來源

1. GTW
2. stackoverflow

2 comments:

CITYWALKER said...

哇!!!
看來你用Android Studio已經用的得心應手了

(羨慕)

潘小鰻 said...

我...也不想啊
(陷入無窮迴圈中)