javascript – 如何使用JSDoc3注释JS模块模式类？

这就是我实际执行此操作的方式,但在生成文档后,私有方法和属性是不可见的.

我做错了什么？

顺便说一下,其他一切都很好.我第一次使用文档生成器,我印象非常深刻.

/**
 * Constructor Description
 * @constructor
 * @class
 * @classdesc Something about my class Foo.
 */
container.Foo = function() { this.init(); };
container.Foo.prototype = (function() {

  /**
   * @private
   * @name container.Foo~fooPropertyPrivat
   * @property {boolean} fooPropertyPrivat Some description
   */   
  var fooPropertyPrivat = true;

  /**
   * Some description
   * @private
   * @name container.Foo~doSomethingPrivat
   * @memberOf container.Foo
   * @method doSomethingPrivat
   */   
  function doSomethingPrivat() {
      //...
  }

  return {
    /**
     * @public
     * @name container.Foo#fooPropertyPublic
     * @property {boolean} fooPropertyPublic Some description
     */ 
    fooPropertyPublic: true,

    /**
     * Some description
     * @public
     * @constructs
     * @name container.Foo#init
     * @memberOf container.Foo
     * @method init
     */
     init: function() {
       //...
     }
  };
})();

解决方法:

拉斐尔,我很高兴听到JSDoc 3到目前为止对你有用！

默认情况下,JSDoc省略了用@private标记的任何符号.您可以使用–private命令行选项覆盖此设置.

标签：javascript,documentation,jsdoc,module-pattern
来源： https://codeday.me/bug/20190625/1285101.html