EzASD 如何編寫自訂API 函式庫的Help

底下將說明如何編寫自訂MYAPI1 和MYAPI2  兩個API的Help說明文件。

image所有的函式庫會集中存放在某個資料夾底下(如下),並且每個函式庫會以單一的檔案形式存在,並配合一個以函式庫名稱加上_HELP後贅字的說明資料夾,存放在一起。

比如底下MYLIB就是函式庫本身,而MYLIB_HELP就是存放MYLIB函式庫說明的資料夾。

 

image

如下圖,MYLIB_HELP底下會有語系資料夾,繁中的說明就存放在CHT資料夾,簡中的說明就存放在CHS資料夾,英文的說明文件就存放在ENG資料夾。

image

步驟1.

如下圖,打開API說明檔存放路徑,將會打開存放該函式庫的繁中說明資料夾。

image

步驟2.

在該資料夾建立一個以該函式庫名稱命名,且延伸檔檔名是.htm的網頁(如底下ASD.htm)。

image

底下以Word為例來編寫API help,只要在每個API說明的第一行插入以API名稱命名的書籤,使用者就可以在API滑鼠右鍵的”幫助”跳轉到該API的說明。

image

如下圖,為每一個API編寫說明,並在起始頭插入以API名稱命名的書籤:

image

最後以網頁htm格式,在該Help存放資料夾存檔。

image

如此,即完成API Help的製作,在該API滑鼠右鍵選單即可呼叫顯示該API的Help說明。

image

拖曳呼叫該API,也會自動顯示該API的說明(如下圖)。

image


發表迴響