2008年4月17日 星期四

N17 API字典與一般字典的異同

所有開放的API都應該撰寫詳細的Java Doc給使用者參考,包括Package、Class、Method、Data,只要是使用者看得到、用得到的東西都應該要有說明。文件的製作就以Java Doc直接產生並加以收集保存,我會稱之為API字典。

不管是哪一種字典,目的都是收納該領域應該有的項目,使用者想了解某個項目的使用說明時,可以根據字典的分類原則從上到下找出需要的項目。不過若是想要表達某個意義,一般的字典卻無法讓使用者條列出符合該意義的所有項目供使用者挑選,使用者只能依印象或請教別人來找出達到某個特定目的的項目,再瀏覽解說看是否符合需要。

API字典的目的,一方面可以讓使用者明白某個Class的功能與有什麼樣的常數與方法,另一方面是明白指出系統內開放使用的API範圍。雖然安排的原則與一般字典相同,但是我們可以搜尋API資料夾的內容來找出擁有搜尋關鍵字的所有檔案,藉此縮小尋找的範圍以希望精確地找出需要的項目。

看到一個API後找出它的使用說明,因為某個目的找出所有可能的API作篩選,這是API字典應該提供給使用者的功能。

沒有留言:

張貼留言