javascript - Yuidoc : 指定参数的性质

Question

我正在尝试使用 yuidoc ( http://yui.github.io/yuidoc/ ) 记录我的 node.js 模块，我想知道如何创建从参数到其实现的链接。

假设我有以下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;

还有一个src/routing/Routes.js

/**
 * Routes
 * @class Routes
 * @module routing
 * @param {Repo} repo - the repo object (from repo.js)
 */
var Routes = function(repo) {
}
modules.exports = Routes;

我如何告诉Routes函数接受一个Repo对象的参数，以便让 yuidoc 在 html 文档中生成正确的超链接？（上面的片段似乎不起作用）

Answer 1

所以，添加@constructor标签很容易！像这样：

/**
 * Routes
 * @class Routes
 * @constructor
 * @module routing
 * @param {Repo} repo - the repo object
 */
var Routes = function(repo) {
}
modules.exports = Routes;