javascript注釋產生文檔的代碼

後來發現這樣的文檔很不方便查看, 且又聽我們BOSS說phper能產生他們的文檔, 我在想js會不會也有一個呢, 於是...你懂的... 通過@廣州♂lxrmido 知道了 jsdoc, 於是 github上down下來; 附地址: https://github.com/jsdoc3/jsdoc
他可以讓你的js產生HTML文檔,如:

代碼如下

複製代碼

/**  * 開啟新視窗  * @param {string} [url] 串連  * @param {object} [options] 配置參數  * @return {object} msc對象  * @example  * 1, msc.open("/");  * 2, msc.open("/",{  * width:1000,  * height:300  * });  */ www.111cn.net function open(url, options) {     var str = "";     if (options) {         options.height = options.height || 420;         options.width = options.width || 550;         options.left = options.left || ((screen.width - options.width) / 2); //預設為置中         options.top = options.top || ((screen.height - options.height) / 2); //預設為置中         for (var i in options) {             str += ',' + i + '=' + options[i];         }         str = str.substr(1);     };     window.open(url, 'connect_window_' + (+new Date), str);     str = null;     return msc; };

使用 jsdoc 後可以解析成,檔案,方法名,參數,例子,傳回值作者等等資訊,且有目錄索引和源碼..相當贊.如圖:

且這隻是她功能的冰山一角, 更多功能有待你的挖掘, 我也是剛剛知道, 不敢獨藏, 於是分享!
注: 有什麼問題可以回複啊, 大家一起研究/討論
我是用node中的cnpm(npm大家都懂的)安裝下
cnpm install jsdoc -g
然後用cmd進行需要的目錄, 直接

jsdoc xl.js
//jsdoc 目錄名
運行, 她會在同目錄產生 out 檔案夾, 然後你就開啟吧. 注: 你的注釋必須按標準走, 我用的sublime裡的DocBlockr加的 ps:標準的注釋會使我們以後的工作更帥氣 更多參數說明請看 github, 或者 官網 http://usejsdoc.org/