2015年1月26日 星期一

API文件怎麼看?

AC的API文件分為兩類,一類是寫外掛用的acapi,另一類則是寫腳本用的jisapi,分別可以在AC目錄下的docs上找到。 這些文件都是透過Java編譯時根據註解自動產生的,所以我也沒辦法做很有規劃的分類(也可以說現在才規劃太晚了),大致就將它當成一個方便查詢的工具就好,在看或寫腳本有不解的地方再來查詢內容會是比較好的用法。

我的用法一般是先開啟index.html,組織上很簡單,以jisapi來說就只有一個package,叫做mod_iscript,所有相關於腳本的API都在這個package中。 畫面開啟後可以看到左右兩邊,左邊是這個package中所有的calss(類別), 右邊亦同,只是右邊將interface(介面)歸類出來, 上方的Tree點下去可以看到這些類別的繼承狀況,從這裡也可以掌握到大致的分類。

接下來就可以點進各個類別裡去看了,類別裡能看的東西就是所謂的成員,也就是述說這個類別裡包含一些什麼東西,可能包含一堆亂七八糟的變數,一些method(函數或稱方法),或是內部的類別。

其他剩下的就是要怎麼解釋這些成員的用途跟意義了,這其實有點困難,就像是某某某給我一本飛行器微電腦控制指令,相信絕對不是只有起飛降落就完結篇了,很多專有名詞或現象環環相扣,是沒有實際操作經驗絕對無法理解的,這也是為什麼我會說API文件是用來查詢的,不是用來讀懂的。文件上很多的內容都寫得比較簡短,當你有百分之五十的概念,很自然就能意會出這些簡短內容的意義,如果還是不懂,我隨時恭候各位的來信^^。

本人僅以個人知識經驗分享,多所無知,難免有錯,還請見諒。