3

我在开始使用 JSDoc3 时遇到了一些麻烦。最重要的是，@params 不会出现！

这是我的测试源：

/**
 * Testing JsDoc3.
 * Why isn't this working `better`?
 */
function foo(bar) {
    console.log(+bar);
}

/**
   A function with params.
   @param {string} baz
   @param {...number} bim
 */
function goo(baz/*, ...bim */) {

}

/**
 * Hello, is this thing on?
 * @namespace bop
 * @type {object}
 */
var bop = {

    sting: function(WHO) {
        console.log(WHO);
    },

    buzz: function(when, why) {

    }

};

我正在跑步./jsdoc -r -l test.js。问题是我得到的输出非常平淡并且缺少很多信息：

JSDoc3 输出

为什么没有参数信息？！我正在使用默认模板；默认模板真的太平淡以至于不显示参数吗？还是我做错了什么？

我尝试为 JSDoc3 寻找一些模板，但并没有真正找到任何好的东西。如果您知道一个很好的工作并且实际上包含有用的信息，请分享。

4

2 回答 2

4

在最新版本的 JSDoc3 的早期版本中记录全局对象时存在一些问题，一切运行良好。

如果您再次尝试使用最新版本，您将获得 goo 全局函数的参数。

但是，如果您想获得更好的描述，则应遵循规则

@param {type} param_name 参数说明 @param 标签、类型、参数名称、参数说明

foo 全局函数不会为您提供任何信息，因为缺少 @param 标记。这是我的代码输出

全局函数

命名空间对象

我在您的原始代码中添加了一些标签：

/** * 测试 JsDoc3。* 为什么这不起作用better？* @method * @param {Object} bar Som bar 值 */ function foo(bar) { console.log(+bar); }

/**
   A function with params.
   @param {string} baz
   @param {...number} bim
   @returns {boolean} return false because we're testing
 */
function goo(baz/*, ...bim */) {
    return false;
}

/**
 * Hello, is this thing on?
 * @namespace bop
 * @type {object}
 */
var bop = {

    /**
    * Hello, is this thing on?
    *
    * @method
    * @param {object} WHO Some Param
    * @memberof bop
    */
    sting: function(WHO) {
        console.log(WHO);
    },

    /**
    * I'm public
    *
    * @method
    * @param {object} when Some Param when
    * @param {object} why Some Param why
    * @memberof bop
    */
    buzz: function(when, why) {
        _buzz(when, why);
    },

    /**
    * I'm inner (private)
    *
    * @inner
    * @method
    * @param {object} when Some Param when
    * @param {object} why Some Param why
    * @memberof bop
    */
    _buzz: function(when, why) {
        console.log(when);
    }

};
于 2013-01-05T23:34:10.310 回答
0

有时它取决于您使用的 jsdoc3 模板。我使用几个模板生成了一个输出，因此我们可以根据自己的需要比较哪个是最合适的：https ://cancerberosgx.github.io/jsdoc-templates-demo/demo/我会随着时间的推移投入更多，但我认为这是确实有助于做出决定。它还记录了它们中的每一个是如何生成的。希望能帮助到你！

于 2017-10-11T01:25:52.243 回答