JsDoc工具包和命名空间 - 警告尝试..没有

时间:2011-09-11 16:54:25

标签: javascript documentation jsdoc

我正在jsdoc-toolkit使用namespace library of Mike Koss。代码看起来像这样

namespace.module('a.b', // this is the namespace

// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {

var entityBase = require("a.base");
var util = require("a.util");

// @class BlaBla
// @constructor
// @property {String} ..
// @property {String} ..
// @property {String} ..
// @property {..} ....
// @param {Array} ...
// @param {X} [optionalParam]
exports.MyClass = function (...) {

创建文档我收到以下消息,并且没有为此类创建任何文档

>> WARNING: Trying to document exports.MyClass without first documenting exports.

我试图通过参数来克服这个问题 - 没有成功。

// @param {Object} exports visible classes within this namespace
// @param {function} required other namespaces
function (exports, require) {

知道如何克服这个问题吗?

1 个答案:

答案 0 :(得分:2)

我已切换到JsDoc 3(https://github.com/micmath/jsdoc#readme)。这个支持模块,因此上面的命名空间库。