为什么这个对象文字不呈现给 JSDoc？

Question

我有以下JavaScript。

它是一个 RequireJS 模块，其函数命名空间为对象文字。我参考了：How do I JSDoc A Nested Object's Methods? 了解如何标记 JSDoc 符号。

I 运行 JSDocs 3.3.0-beta3 with private: true 在 g运行t 任务中，但在模块页面上没有私有方法或 public 方法的参数。

/**
 * A module doing a lot of Foo.
 * @module Foo
 * @requires jquery
 * @author Markus Falk
 */
define(['jquery'], function($) {

  'use strict';

  /**
   * @property {Object} Container
   */
  var Foo = {
    /**
     * Caches all jQuery Objects for later use
     * @function
     * @private
     */
    _cacheElements: function() {
      this.$foo = $('.foo');
    },
    /**
     * inits the app and returns the Message Text
     * @function
     * @public
     * @param {Object} msg - The message.
     * @param {string} msg.text - The message's Text.
     * @param {string} msg.author - The message's author.
     * @returns {String} Sentence with given message.text
     */
    init: function(msg) {
      this._cacheElements();
      return "Say " + msg.text;
    }
  };

  return /** @alias module:Foo */ {
    /** init */
    init: Foo.init
  };
});

这是这个 JSDoc 代码的输出：

Answer 1

试试 @function init 和 @function _cacheElements

/**
 * A module representing a Foo.
 * @module Foo
 * @requires jquery
 * @author Markus Falk
 */
define(['jquery'], function($) {

  'use strict';

  /**
   * @property {Object} Container
   */
  var Foo = {
    /**
     * Caches all jQuery Objects for later use
     * @function _cacheElements
     * @private
     */
    _cacheElements: function() {
      this.$foo = $('.foo');
    },
    /**
     * inits the app and returns the Message Text
     * @function init
     * @public
     * @param {Object} msg - The message.
     * @param {string} msg.text - The message's Text.
     * @param {string} msg.author - The message's author.
     * @returns {String} Sentence with given message.text
     */
    init: function(msg) {
      this._cacheElements();
      return "Say " + msg.text;
    }
  };

  return /** @alias module:Foo */ {
    /** init */
    init: Foo.init
  };
});

为什么这个对象文字不呈现给 JSDoc？

Why does this object literal not render to JSDoc?

javascript

jsdoc

object-literal

jsdoc3