Javascript Yuidoc:指定参数的性质
我试图用yuidoc()记录我的node.js模块,我想知道如何创建一个从param到其实现的链接 假设我有以下Javascript Yuidoc:指定参数的性质,javascript,node.js,yuidoc,Javascript,Node.js,Yuidoc,我试图用yuidoc()记录我的node.js模块,我想知道如何创建一个从param到其实现的链接 假设我有以下src/core/Repo.js /** * Repo * @class Repo * @module core */ var Repo = function() { /** * Insert stuff * @param {Object} obj - some stuff * @param {Function} callback - error/succ
src/core/Repo.js
/**
* Repo
* @class Repo
* @module core
*/
var Repo = function() {
/**
* Insert stuff
* @param {Object} obj - some stuff
* @param {Function} callback - error/success callback
*/
var _insert() = function(obj, callback) {
}
return {
insert : _insert
}
}
module.exports = Repo;
/**
* Routes
* @class Routes
* @module routing
* @param {Repo} repo - the repo object (from repo.js)
*/
var Routes = function(repo) {
}
modules.exports = Routes;
和asrc/routing/Routes.js
/**
* Repo
* @class Repo
* @module core
*/
var Repo = function() {
/**
* Insert stuff
* @param {Object} obj - some stuff
* @param {Function} callback - error/success callback
*/
var _insert() = function(obj, callback) {
}
return {
insert : _insert
}
}
module.exports = Repo;
/**
* Routes
* @class Routes
* @module routing
* @param {Repo} repo - the repo object (from repo.js)
*/
var Routes = function(repo) {
}
modules.exports = Routes;
如何告诉
Routes
函数接受param aRepo
对象,以便让yuidoc在html文档中生成正确的超链接?(上面的代码片段似乎不起作用)因此,添加@constructor
标记很容易!像这样:
/**
* Routes
* @class Routes
* @constructor
* @module routing
* @param {Repo} repo - the repo object
*/
var Routes = function(repo) {
}
modules.exports = Routes;