在Titanium使用JSDoc產生API文件

這篇來說明一下如何使用jsDoc，

我是在mac系統底下執行，

window系統資訊很多應該很多資料很容易查到。

首先先下載  jsdoc-toolkit jsdoc_toolkit-2.4.0.zip的檔案。

將zip檔解開放到你知道的位置。

一開始我以為要安裝，一直找不到如何安裝，但後來發現解壓縮完就可以用啦。

把你的js檔內加入註釋，但註釋需依照規範來寫，寫比較常見的幾個，

其它就看輔助網站囉~

例如有個method叫做 add()  ，用來相加兩個數的結果。

/**
* 將兩數相加，回傳總和
*
*@param {int} 傳入第一個整數
*@param {int} 傳入第二個整數 
*
*@return {int} 回傳總和的數字
*/

var add = function( a, b)
{
    var result = a + b;
    return result;
}


接下來去終端機下指令：
先移到你的jsdoc那個資料夾(剛才下載解完壓縮的地方)

java -jar jsrun.jar app/run.js -a -t=templates/jsdoc /Users/mac/Desktop/james/project/titanium/xxxx/Resources/*.js

你也可以直接指定檔名 。

接下來在jsdoc的那個資料夾內你會看見一個out的資料夾，裡面就是你的API文件了~

其它的註釋規範可以參考這裡。