jsdoc注释规范工具（使用 JSDoc 3 自动生成 JavaScript API 文档）

标签：

安装和使用规范见：http://moodpo.com/archives/jsdoc3-tutorial.html

实例：

/**
 * 模块调用方法
 *
 * 
 * @param  {string}   moduleName 模块名称
 * @param  {Function} callback   模块加载完成的回调，回调函数中会返回模块对象，方便内部调用
 * @param  {Boolean}  isQueue    是否加入队列：在队列中的文件逐个加载（非异步）
 * @param  {date}     timeout    延时加载的时间以毫秒为单位
 * 
 * @return {[type]}              不管模块是否加载成功，都会返回跟对象，便于链式调用 ; 
 *                               链式调用与模块的加载情况是异步的，没有依赖关系，
                                 所以在链式调用中不能确保能够调用到模块中的方法
 * @example

            xue.use(‘pages‘, function(module){
                // 根据模块名称进行调用
                xue.pages.config({
                    pages : 22,
                    current : 1
                }).go(3);

                // 根据返回的对象进行调用
                module(‘page2‘).config({
                    pages: 10,
                    current: 3
                });
            }, true, 1000).test();
 */

jsdoc注释规范工具（使用 JSDoc 3 自动生成 JavaScript API 文档）

标签：

原文地址：http://www.cnblogs.com/dearxinli/p/4545705.html