我正试图找到一种使用JSDoc3记录AMD模块的方法.
/**
* Module description.
*
* @module path/to/module
*/
define(['jquery', 'underscore'], function (jQuery, _) {
/**
* @param {string} foo Foo-Description
* @param {object} bar Bar-Description
*/
return function (foo, bar) {
// insert code here
};
});
Run Code Online (Sandbox Code Playgroud)
可悲的是,http://usejsdoc.org/howto-commonjs-modules.html上列出的模式都不适用于我.
如何生成一个适当的文档,列出模块导出的函数的参数和返回值?