JsDoc工具包和命名空间 - 警告尝试..没有 [英] JsDoc toolkit and Namespace - Warning trying to .. without

问题描述

我正在使用 jsdoc-toolkit 与命名空间库。代码看起来像这样

I am using jsdoc-toolkit with the namespace library of Mike Koss. The code looks like this

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 (...) {

创建文档我得到以下消息，没有文档创建在这个类。

Creating documentation I get the following message and no documentation is created at all for this class.

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

我已经尝试克服了param行的问题 - 没有成功。

I have tried to overcome the issue with the param lines - no success.

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

任何想法如何克服这个问题？

Any idea how to overcome the issue?

推荐答案

我已经切换到 JsDoc 3 （https://github.com/micmath/jsdoc#readme）。这个支持模块，因此是上述命名空间库。

I have switched to JsDoc 3 (https://github.com/micmath/jsdoc#readme). This support modules and hence the above namespace library.

这篇关于JsDoc工具包和命名空间 - 警告尝试..没有的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！