【问题标题】:JsDoc toolkit and Namespace - Warning trying to .. withoutJsDoc 工具包和命名空间 - 警告试图 .. 没有
【发布时间】:2011-09-16 22:28:40
【问题描述】:

我正在使用 jsdoc-toolkitnamespace 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) {

知道如何解决这个问题吗?

【问题讨论】:

    标签: javascript documentation jsdoc


    【解决方案1】:

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

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2012-02-26
      • 1970-01-01
      • 2013-03-25
      • 2013-02-18
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多