从JSDoc3获得更好的输出

Question

我在开始使用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寻找一些模板，但并没有真正找到任何好的地方。如果你知道一个好的，工作和实际包含有用的信息，请分享。

Answer 1

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

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

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

@param { type } param_name参数描述@param标记，类型，param名称，参数描述

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

​

​

​

​

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

/** *测试JsDoc3。*为什么这个better不能工作？*@方法* @param {Object} bar Som bar值*/ function (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);
    }

};

Answer 2

有时它取决于您正在使用的jsdoc3模板。我使用几个模板生成了一个输出，这样我们就可以根据需要比较哪一个最合适：https://cancerberosgx.github.io/jsdoc-templates-demo/demo/，我会花费更多的时间，但我认为这对做出决定非常有帮助。此外，它还记录了它们中的每一个是如何生成的。希望能帮上忙！