Apidoc 菜鳥教學
快速產生 Api 文件的利器
新手小小心得文
還在用 Word 寫 Api 文件嗎？ ( 還使只有我這麼菜 …？
這邊介紹一個好用的小工具 — Apidoc
只要打打一些簡單的 code 就可以生出一個簡單好看的目錄網頁
是不是很簡單 ( 搖肩
OK 廢話結束，我們馬上開始吧！
Step 2. 安裝 Apidoc
再安裝我們的主角之前，還必須確定 npm(node package manager，Node 安裝包管理器) 有正確的安裝完畢。
打開 Node.js command prompt ( 若找不到檔案可以在 C:\ 右上角或 Spotlight 搜尋 )
輸入以下指令若跑出以下畫面則表示安裝成功。
npm
接下來就是安裝 Apidoc。
輸入以下指令來安裝 Apidoc。
npm install apidoc -g若出現下圖資訊則表示安裝成功。
Step 3. Apidoc 內容建置
先來介紹這個指令
- - i：選擇程式碼所在的目錄位置( 以 First_apidoc /為例，可自行替換。)
- - o：選擇生成的目標檔案所在的位置(以 First_apidoc/資料夾下的apidoc /資料夾為例，可自行替換。)
#可以通過搜索First_apidoc的上層目錄中的First_apidoc檔案快速的生成文檔檔案，並將這些檔案放在被你命名為apidoc的目錄下。
#記得先cd至First_apidoc的上層目錄才能搜索First_apidoc檔案的位置
apidoc -i First_apidoc/ -o First_apidoc/apidoc/不過在執行此命令前，我們必須先建立程式碼所在的目錄位置，也就是First_apidoc 資料夾和裡面的兩個檔案。
這兩個檔案分別是 apidoc的項目配置 .json 檔以及內容編寫的 .js demo 檔
Note：Apidoc 並不具有語意識別能力，所以它不會發現代碼中是否有BUG，它只能透過檔案的副檔名來判斷語言類型，這裡就用 .js 的 demo 檔為例。
apidoc.json 檔範例：
api.js 檔範例：
Step 4. 生成 Apidoc
一切準備就緒後，就可以來生成我們的 Apidoc 啦！
打開 cmd 並 cd 到 Apidoc 的工作目錄層 ( First_apidoc /的上一層 )
輸入以下指令
apidoc -i First_apidoc/ -o apidoc/若出現 message：Done. 的字樣，即表示指令成功。
接著可以發現在 First_apidoc / 同一層的目錄中出現了名為 apidoc/ 的資料夾，此資料夾即為 - o 指令所生成。
最後打開 apidoc/ 資料夾裡的 index.html 檔，就可以看到 api.js 檔中所 demo 的內容囉！
Note：只要有更動 .json 或 .js 檔，就必須要再下一次 apidoc 生成指令喔！
以上是版主不專業的 Apidoc 建立和學習紀錄，內容參考 “使用apidocJs快速生成在線文檔 ”這篇文章，本篇如有錯誤或不足，內有更詳細解說，也歡迎留言指教。
