Javascript 从JSDoc3获得更好的输出

我在开始使用JSDoc3时遇到了一些问题。最重要的是，

@param

不会显示

以下是我的测试来源：

/**
 * 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的早期版本中记录全局对象时出现了一些问题，一切都正常

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

但是如果你想得到更好的描述，你应该遵循这个规则

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

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

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

/** *测试JsDoc3。 *为什么这样做不更好？ *@方法 *@param{Object}bar Som bar值 */ 函数foo（bar）{ 控制台日志（+bar）； }

---

有时，这取决于您使用的jsdoc3模板。我使用几个模板生成了一个输出，以便我们可以根据需要比较哪一个最适合：我会随着时间的推移投入更多，但我认为这确实有助于做出决定。它还记录了它们是如何生成的。希望有帮助

/**
   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);
    }

};